API XML
This documentation is for an older version of the API. We recommend using the REST API for Fishbowl Advanced.
Legacy Objects
| Legacy Object | Syntax | Description |
|---|---|---|
| Account | Account | Contains information on accounts in the database. |
| Address | Address | An object containing information about an address. |
| Carton | Carton | Stores information about a carton. |
| Carrier | Carrier | This object just contains the carrier's name. |
| Contacts | Contacts | Object that contains Contact Information. |
| Contact Information | ContactInformation | Contains information about a contact. |
| Credit Card | CreditCard | Contains information about a credit card. |
| Customer | Customer | Contains customer information. |
| Custom Field | CustomField | Stores the details about a Fishbowl custom field. |
| Custom List | CustomList | A list of custom items. |
| Custom List Item | CustomListItem | Stores custom items. |
| Discount | Discount | Stores discount information. |
| Location | Location | Represents a location. |
| Location Group | LocationGroup | Compacts Location Group name and ID into one object. |
| Memo | Memo | Stores additional notes on requests and objects. |
| Order History | OrderHistory | This is a storage object for order history. |
| Parameter | Parameter | Contains name and value module parameters. |
| Part | Part | Stores information about a part. |
| Payment | Payment | Contains payment information. |
| Pick | Pick | Stores all the information associated with a pick. |
| Pick Item | PickItem | Stores information about items that are involved in a pick. |
| Product | Product | Contains information about a product. |
| Purchase Order | PurchaseOrder | Object used to store data concerning a purchase order. |
| Receipt | Receipt | Contains receipt information. |
| Report | Report | Contains report information. |
| Report Tree | ReportTree | Contains report tree information. |
| Sales Order | SalesOrder | Stores sales order information. |
| Sales Order Item | SalesOrderItem | Stores sales order item information. |
| Shipping | Shipping | Contains the details about a shipment. |
| Tag | Tag | A number that helps describe a location. |
| Tax Rate | TaxRate | Stores tax rate information. |
| Tracking | Tracking | This simply contains the TrackingItem objects. |
| Tracking Item | TrackingItem | This object contains the information being tracked. |
| UOM | UOM | Contains unit of measure details. |
| UOM Conversion | UOMConversion | Stores conversion information for a unit of measure. |
| User | User | User details. |
| Vendor | Vendor | Contains all the vendor information and details. |
| Vendor Part Number | VendorPartNumber | Object that contains the Vendor Part Number. |
| Work Order | WO | Contains all the work order information and details. |
| Work Order Item | WOItem | Stores information about an item found in a work order. |
Legacy Requests
| Legacy Request | Syntax | Brief Description |
|---|---|---|
| Add Inventory Request | AddInventoryRq | Adds initial inventory of a part. |
| Add Memo Request | AddMemoRq | Adds a memo to the specified object. |
| Add SO Item Request | AddSOItemRq | Adds an item to an SO. |
| Add WO Item Request | AddWorkOrderItemRq | Adds an item to an existing open WO. |
| Build BOM Request | BuildBomRq | Creates an MO for a specific BOM. |
| Calculate SO Request | CalculateSORq | Returns a potential order summary (unsaved). |
| Carrier List Request | CarrierListRq | Returns the shipping carriers stored in the database. |
| Close Short SO Request | CloseShortSORq | This request is used to close short a sales order. |
| Customer Get Request | CustomerGetRq | Returns the information for a specific customer. |
| Customer List Request | CustomerListRq | Returns every customer's information. |
| Customer Name List Request | CustomerNameListRq | Returns the names of all customers. |
| Cycle Count Request | CycleCountRq | Used to correct inventory amounts. |
| Email Report Request | EmailReportRq | Emails a report to a given email address. |
| Export List Request | ExportListRq | Returns a list of available exports. |
| Export Request | ExportRq | Returns export data of the specified export type. |
| Execute Query Request | ExecuteQueryRq | Returns results of sql query in csv format. |
| Get Account Balance Request | GetAccountBalanceRq | Returns QuickBooks value for the specified account. |
| Get Account List Request | GetAccountListRq | Returns a list of all QuickBooks accounts. |
| Get Part List Request | GetPartListRq | Returns a list of parts based on the search parameters. |
| Get Pick Request | GetPickRq | Returns information on the specified pick. |
| Get PO List Request | GetPOListRq | Returns all PO from a given location. |
| Get Receipt Request | GetReceiptRq | Returns receipt information. |
| Get Ship List Request | GetShipListRq | Request a list of shipments. |
| Get Shipment Request | GetShipmentRq | Returns the shipment details about the specified shipment. |
| Get Ship Now List Request | GetShipNowListRq | Requests a list of shipments ready to ship. |
| Get SO List Request | GetSOListRq | Returns a list of SOs based on the search parameters. |
| Get Total Inventory Request | GetTotalInventoryRq | Returns the number of an item at a specific location. |
| Import List Request | ImportListRq | Returns a list of your import options. |
| Import Request | ImportRq | Request allows you to import data. |
| Import Headers Request | ImportHeaderRq | Returns a list of import header for a specific import. |
| Inventory Quantity Request | InvQtyRq | Returns details and quantity of a specified part or list of parts. |
| Issue SO Request | IssueSORq | Issues an SO. |
| Light Part List Request | LightPartListRq | Returns a simple list of parts. |
| Load SO Request | LoadSORq | Returns information on a sales order. |
| Location Group Request | LocationGroupRq | Returns a list of the location groups. |
| Location List Request | LocationListRq | Returns a list of locations and their details. |
| Location Query Request | LocationQueryRq | Returns information on a location. |
| Login Request | LoginRq | Logs a user in or out of Fishbowl. |
| Make Payment Request | MakePaymentRq | Makes a payment on the specified order. |
| Move Request | MoveRq | Moves items from one specified location to another. |
| Part Cost Request | PartCostRq | Obtains the average cost. |
| Part Get Request | PartGetRq | Returns details about a part. |
| Part Query Request | PartQueryRq | Also returns details about a part. |
| Pick Query Request | PickQueryRq | Returns all picks specified. |
| Print Report Request | PrintReportRq | Prints the default report for the specified module. |
| Product Get Request | ProductGetRq | Requests detailed information about the product. |
| Product Price Request | ProductPriceRq | Requests the best price for a given product. |
| Quick Ship Request | QuickShipRq | Will do an automatic pick, pack, and ship on an SO. |
| Receiving List Request | ReceivingListRq | Returns information about orders in the Receiving module. |
| Save Discount Request | SaveDiscountRq | Saves and updates discounts. |
| Save Image Request | SaveImageRq | Saves an image to the associated object. |
| Save Pick Request | SavePickRq | Enables the fulfillment and adjustments to picks. |
| Save Receipt Request | SaveReceiptRq | Updates receipt stored data. |
| Save Report Request | SaveReportRq | Saves the report data. |
| Save Shipment Request | SaveShipmentRq | Saves the shipment data. |
| Save UPC Request | SaveUPCRq | Request permits the change of a product UPC. |
| Set Def Part Loc Request | SetDefPartLocRq | Enables you to change the default location of a part. |
| Save Tax Rate Request | SaveTaxRateRq | Saves and updates tax rates. |
| Ship Request | ShipRq | Ships an order. |
| UOM Request | UOMRq | Requests a list of UOMs. |
| Vendor Get Request | VendorGetRq | Retrieves a vendor object. |
| Vendor List Request | VendorListRq | Requests a list of all vendors. |
| Vendor Name List Request | VendorNameListRq | Requests a list of all vendor names. |
| Void Shipment Request | VoidShipmentRq | This request is used to void shipments that are in a packed status or shipped status. |
| Void SO Request | VoidSORq | This request is used to void sales orders. |
Legacy Examples
Each example listed below will include 3 things.
- A description
- The generic syntax
- An example using the EXAMPLE.FDB database included with Fishbowl
Within the syntax section, formats accepted within the object are specified in red text. Any occurrences of the letters DB refer to a value used as a variable within the database. For instance, <OrderTypeID>DB int</OrderTypeID> expects one of following numbers: 1, 10, 20, 30, or 40. Each number specifies an order type. 1 being none, 10 a purchase order, and so on. The values, and their significance, can be found by accessing the database tables in the Data module. Other indicators within the syntax include int, string, boolean, double, and date/time. These are all typical coding data types, aside from date/time. Below is the format and an example for inputting date/time.
- year-month-dayThours:minutes:seconds
- 2019-08-17T15:43:51
OBJECTS
Description: This contains information relevant to one of the financial accounts in the Fishbowl database.
Syntax:
<Account> <Name>string</Name> <AccountingID>string</AccountingID> <AccountType>int</AccountType> <Balance>string</Balance> </Account>
Example:
<Account> <Name>Cost Variance</Name> <AccountingID>8000001B-1310422643</AccountingID> <AccountType>12</AccountType> <Balance>0</Balance> </Account>
Description: An object containing information about an address. There are no fields that are essential for the use of an address object. Use only those fields that you need.
Syntax:
<Address> <ID>int</ID> <Temp-Account> <ID>int</ID> <Type>DB int</Type> </Temp-Account> <Name>string</Name> <Attn>string</Attn> <Street>string</Street> <City>string</City> <Zip>string</Zip> <LocationGroupID>int</LocationGroupID> <Default>boolean</Default> <Residential>boolean</Residential> <Type>DB string</Type> <State> <ID>DB int</ID> <Code>string</Code> <Name>string</Name> <CountryID>DB int</CountryID> </State> <Country> <ID>DB int</ID> <Name>string</Name> <Code>string</Code> </Country> <AddressInformationList> <AddressInformation> <ID>int</ID> <Name>string</Name> <Data>{{r|string}}</Data> <Default>boolean</Default> <Type>string</Type> </AddressInformation> </AddressInformationList> </Address>
Example:
<Address> <Temp-Account> <Type>10</Type> </Temp-Account> <Name>Main Office</Name> <Attn>Attn</Attn> <Street>123 Neverland dr.</Street> <City>Murray</City> <Zip>84121</Zip> <Default>true</Default> <Residential>false</Residential> <Type>Main Office</Type> <State> <Name>Utah</Name> <Code>UT</Code> <CountryID>2</CountryID> </State> <Country> <Name>United States</Name> <Code>US</Code> </Country> <AddressInformationList> <AddressInformation> <Name>Main Office</Name> <Data>Address Data</Data> <Default>true</Default> <Type>Home</Type> </AddressInformation> </AddressInformationList> </Address>
Description: This stores information about a carton.
Syntax:
<Carton> <ID>int</ID> <ShipID>int</ShipID> <CartonNum>int</CartonNum> <TrackingNum /> <FreightWeight>int</FreightWeight> <FreightAmount>int</FreightAmount> <ShippingItems> <ShippingItem> <ShipItemID>int</ShipItemID> <ProductNumber>string</ProductNumber> <ProductDescription>string</ProductDescription> <QtyShipped>int</QtyShipped> <UOM>UOM object</UOM> <Cost>int</Cost> <SKU /> <UPC /> <OrderItemID>int</OrderItemID> <OrderLineItem>int</OrderLineItem> <CartonName>string</CartonName> <CartonID>int</CartonID> <TagNum>int</TagNum> <Weight>int</Weight> <WeightUOM> <UOM>UOM object</UOM> </WeightUOM> <DisplayWeight>int</DisplayWeight> <DisplayWeightUOM> <UOM>UOM object</UOM> </DisplayWeightUOM> <Tracking /> </ShippingItem> </ShippingItems> </Carton>
Example:
<Carton> <ID>64</ID> <ShipID>63</ShipID> <CartonNum>1</CartonNum> <TrackingNum /> <FreightWeight>1.2</FreightWeight> <FreightAmount>0</FreightAmount> <ShippingItems> <ShippingItem> <ShipItemID>169</ShipItemID> <ProductNumber>B201</ProductNumber> <ProductDescription>Heavy Duty Brake Cables</ProductDescription> <QtyShipped>1</QtyShipped> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <Cost>0</Cost> <SKU /> <UPC /> <OrderItemID>160</OrderItemID> <OrderLineItem>1</OrderLineItem> <CartonName>1</CartonName> <CartonID>64</CartonID> <TagNum>694</TagNum> <Weight>1.2</Weight> <WeightUOM> <UOM> <UOMID>3</UOMID> <Name>Pound</Name> <Code>lbs</Code> <Integral>false</Integral> <Active>true</Active> <Type>Weight</Type> <UOMConversions> <UOMConversion> <MainUOMID>3</MainUOMID> <ToUOMID>8</ToUOMID> <ToUOMCode>kg</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.2046000957489014</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </WeightUOM> <DisplayWeight>1.2</DisplayWeight> <DisplayWeightUOM> <UOM> <UOMID>3</UOMID> <Name>Pound</Name> <Code>lbs</Code> <Integral>false</Integral> <Active>true</Active> <Type>Weight</Type> <UOMConversions> <UOMConversion> <MainUOMID>3</MainUOMID> <ToUOMID>8</ToUOMID> <ToUOMCode>kg</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.2046000957489014</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </DisplayWeightUOM> <Tracking /> </ShippingItem> </ShippingItems> </Carton>
Description: This object just contains the carrier's name.
Syntax:
<Carrier>
<Name>string</Name>
</Carrier>
Example:
<Carrier> <Name>Will Call</Name> </Carrier>
Description: This contains Contact Information.
Syntax:
<Contacts>Contact Information object</Contacts>
Example:
<Contacts> <ContactInformation> <ContactName>Josh Anderson</ContactName> <Type>Web</Type> <Data>https://fishbowlinventory.com</Data> </ContactInformation> </Contacts>
Description: This stores a detail about a contact. There are no fields that are essential for the use of a Contact Information object. Use only those fields that you need.
Syntax:
<ContactInformation> <ContactName>string</ContactName> <ContactID>int</ContactID> <Type>int</Type> <Data>{{r|string}}</Data> <Default>boolean</Default> </ContactInformation>
Example:
<ContactInformation> <ContactName>Josh Anderson</ContactName> <Type>Web</Type> <Data>https://fishbowlinventory.com</Data> </ContactInformation>
Description: This stores credit card information to be used in a credit card payment.
Syntax:
<CreditCard> <CardNumber>string</CardNumber> <CardExpMonth>int</CardExpMonth> <CardExpYear>int</CardExpYear> <SecurityCode>string</SecurityCode> <NameOnCard>string</NameOnCard> <CardAddress>string</CardAddress> <CardZipCode>string</CardZipCode> <CardCountryCode>string</CardCountryCode> </CreditCard>
Example:
<CreditCard> <CardNumber>411111111111111</CardNumber> <CardExpMonth>02</CardExpMonth> <CardExpYear>19</CardExpYear> <SecurityCode>523</SecurityCode> <NameOnCard>John Doe</NameOnCard> <CardAddress>123 S Riverdale Road</CardAddress> <CardZipCode>84172</CardZipCode> <CardCountryCode>US</CardCountryCode> </CreditCard>
Description: This stores the details about a customer. You must include the JobDepth field. There are no other fields that are essential for the use of a Customer object. Use only those fields that you need.
Updated: 2013.0
Syntax:
<Customer> <CustomerID>int</CustomerID> <AccountID>int</AccountID> <Status>string (Normal, Preferred, Hold Sales, Hold Shipment or Hold All)</Status> <DefPaymentTerms>string</DefPaymentTerms> <DefShipTerms>string</DefShipTerms> <TaxRate>string</TaxRate> <Name>string</Name> <Number>string</Number> <DateCreated>date/time</DateCreated> <DateLastModified>date/time</DateLastModified> <LastChangedUser>string</LastChangedUser> <CreditLimit>price</CreditLimit> <TaxExempt>boolean</TaxExempt> <TaxExemptNumber>string</TaxExemptNumber> <Note>string</Note> <ActiveFlag>boolean</ActiveFlag> <AccountingID>string</AccountingID> <CurrencyName>DB string</CurrencyName> <CurrencyRate>double</CurrencyRate> <DefaultSalesman>DB String</DefaultSalesman> <DefaultCarrier>DB String</DefaultCarrier> <DefaultShipService>DB String</DefaultShipService> <JobDepth>int</JobDepth> <QuickBooksClassName>DB String</QuickBooksClassName> <ParentID>int</ParentID> <PipelineAccount>int</PipelineAccount> <URL>string</URL> <Addresses>Address objects</Addresses> <CustomFields> <CustomField>Custom Field object</CustomField> </CustomFields> </Customer>
Example:
<Customer> <Status>Normal</Status> <DefPaymentTerms>COD</DefPaymentTerms> <DefShipTerms>Prepaid</DefShipTerms> <TaxRate>None</TaxRate> <Name>Sam Ball</Name> <CreditLimit>1000000.00</CreditLimit> <TaxExempt>true</TaxExempt> <TaxExemptNumber>12345</TaxExemptNumber> <Note>Hello World</Note> <ActiveFlag>true</ActiveFlag> <DefaultSalesman>jen</DefaultSalesman> <DefaultCarrier>USPS</DefaultCarrier> <JobDepth>1</JobDepth> <Addresses> <Address> <Temp-Account> <Type>10</Type> </Temp-Account> <Name>Main Office</Name> <Attn>Attention</Attn> <Street>123 Neverland dr.</Street> <City>Murray</City> <Zip>84121</Zip> <Default>true</Default> <Residential>false</Residential> <Type>Main Office</Type> <State> <Name>Utah</Name> <Code>UT</Code> <CountryID>2</CountryID> </State> <Country> <Name>United States</Name> <Code>US</Code> </Country> <AddressInformationList> <AddressInformation> <Name>Main Office</Name> <Data>Address Data</Data> <Default>true</Default> <Type>Home</Type> </AddressInformation> </AddressInformationList> </Address> </Addresses> <CustomFields> <CustomField> <Type>CFT_TEXT</Type> <Name>Custom1</Name> <Info>Custom Data</Info> </CustomField> </CustomFields> </Customer>
Description: This stores the details about a Fishbowl custom field.
Syntax:
<CustomField> <ID>int</ID> <Type>string</Type> <Name>string</Name> <Description>string</Description> <SortOrder>int</SortOrder> <Info>string</Info> <RequiredFlag>boolean</RequiredFlag> <ActiveFlag>boolean</ActiveFlag> <CustomList>Custom List objects</CustomList> </CustomField>
Description: A list of custom items.
Syntax:
<CustomList> <ID>int</ID> <Name>string</Name> <Description>string</Description> <CustomListItems>Custom List Item objects</CustomListItems> </CustomList>
Description: Stores Custom Items.
Syntax:
<CustomListItem> <ID>int</ID> <Name>string</Name> <Description>string</Description> </CustomListItem>
Description: This stores discount information.
Syntax:
<Discount> <ID>int</ID> <Name>string</Name> <Description>string</Description> <Type>string</Type> <TypeID>int</TypeID> <Percentage>double</Percentage> <Amount>double</Amount> <TaxableFlag>boolean</TaxableFlag> </Discount>
Description: This represents a location.
Syntax:
<Location> <LocationID>int</LocationID> <TypeID>int</TypeID> <ParentID>int</ParentID> <Name>string</Name> <Description>string</Description> <CountedAsAvailable>boolean</CountedAsAvailable> <Default>boolean</Default> <Active>boolean</Active> <Pickable>boolean</Pickable> <Receivable>boolean</Receivable> <LocationGroupID>int</LocationGroupID> <LocationGroupName>string</LocationGroupName> <EnforceTracking>boolean</EnforceTracking> <SortOrder>int</SortOrder> </Location>
Example:
<Location> <LocationID>0</LocationID> <TypeID>0</TypeID> <Name /> <Description /> <CountedAsAvailable>true</CountedAsAvailable> <Active>true</Active> <Pickable>true</Pickable> <Receivable>true</Receivable> <LocationGroupID>0</LocationGroupID> <LocationGroupName /> <TagID>-1</TagID> <TagNumber>-1</TagNumber> </Location>
Description: This is used to compact a Location Group name and ID into one object.
Syntax:
<LocationGroup> <LocationGroupID>int</LocationGroupID> <LocationGroupName>string (REQUIRED)</LocationGroupName> <UsersDefaultLG>boolean</UsersDefaultLG> </LocationGroup>
- OR
<LocationGroup>string</LocationGroup>
Example:
<LocationGroup> <LocationGroupID>1</LocationGroupID> <LocationGroupName>SLC</LocationGroupName> <DefaultQBClassID>2</DefaultQBClassID> </LocationGroup>
- OR
<LocationGroup>SLC</LocationGroup>
Description: This stores additional notes on requests and objects.
Syntax:
<Memo> <ID>int</ID> <Memo>string</Memo> <UserName>string</UserName> <DateCreated>date/time</DateCreated> </Memo>
Description: This is a storage object for order history.
Syntax:
<OrderHistory> <ID>int</ID> <UserName>string</UserName> <DateCreated>date/time</DateCreated> <Comment>string</Comment> <TableID>int</TableID> <RecordID>int</RecordID> </OrderHistory>
Example:
<OrderHistory> <ID>314</ID> <UserName>admin</UserName> <DateCreated>2019-08-08T11:15:16</DateCreated> <Comment>Receipt Created</Comment> <TableID>-2001398668</TableID> <RecordID>91</RecordID> </OrderHistory>
Description: This contains name and value module parameters.
Syntax:
<Parameter> <Name>string</Name> <Value>string</Value> </Parameter>
Example:
<ReportParam> <Name>shipID</Name> <Value>33</Value> </ReportParam>
Description: This stores information about a part.
Syntax:
<Part> <PartID>int</PartID> <PartClassID>int</PartClassID> <TypeID>int</TypeID> <UOM>int</UOM> <Num>string</Num> <Description>string</Description> <Manufacturer>string</Manufacturer> <Details>string</Details> <ABCCode /> <TagLabel>string</TagLabel> <StandardCost>string</StandardCost> <HasBOM>boolean</HasBOM> <Configurable>boolean</Configurable> <ActiveFlag>boolean</ActiveFlag> <SerializedFlag>boolean</SerializedFlag> <TrackingFlag>boolean</TrackingFlag> <UsedFlag>boolean</UsedFlag> <Weight>quantity</Weight> <WeightUOMID>quantity</WeightUOMID> <Width>quantity</Width> <Height>quantity</Height> <Len>quantity</Len> <SizeUOMID>int</SizeUOMID> <UPC /> <PartTrackingList> <PartTracking /> </PartTrackingList> <VendorPartNums>string</VendorPartNums> <Image>string</Image> </Part>
Example:
<Part> <PartID>60</PartID> <PartClassID>0</PartClassID> <TypeID>10</TypeID> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <Num>BB2005</Num> <Description>Custom Value Bike</Description> <Details /> <StandardCost>0</StandardCost> <HasBOM>false</HasBOM> <Configurable>true</Configurable> <ActiveFlag>true</ActiveFlag> <SerializedFlag>true</SerializedFlag> <TrackingFlag>true</TrackingFlag> <Weight>0</Weight> <WeightUOM> <UOM> <UOMID>3</UOMID> <Name>Pound</Name> <Code>lbs</Code> <Integral>false</Integral> <Active>true</Active> <Type>Weight</Type> <UOMConversions> <UOMConversion> <MainUOMID>3</MainUOMID> <ToUOMID>8</ToUOMID> <ToUOMCode>kg</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.2046000957489014</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </WeightUOM> <Width>0</Width> <Height>0</Height> <Len>0</Len> <SizeUOM> <UOM> <UOMID>2</UOMID> <Name>Foot</Name> <Code>ft</Code> <Integral>false</Integral> <Active>true</Active> <Type>Length</Type> <UOMConversions> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>7</ToUOMID> <ToUOMCode>in</ToUOMCode> <ConversionMultiply>12.0</ConversionMultiply> <ConversionFactor>1.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>9</ToUOMID> <ToUOMCode>m</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>3.2808001041412354</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </SizeUOM> <UPC /> <PartTrackingList> <PartTracking> <PartTrackingID>4</PartTrackingID> <Name>Serial Number</Name> <Abbr>SN(s)</Abbr> <Description /> <SortOrder>4</SortOrder> <TrackingTypeID>40</TrackingTypeID> <Active>true</Active> <Primary>true</Primary> </PartTracking> </PartTrackingList> </Part>
Description: This contains payment information.
Syntax:
<Payment> <Amount>double</Amount> <SalesOrderNumber>string</SalesOrderNumber> <CurrencyRate>double</CurrencyRate> <PaymentDate>date/time</PaymentDate> <PaymentMethod>DB sting</PaymentMethod> <Reference>string</Reference> <Confirmation>string</Confirmation> <ExpirationDate>date/time</ExpirationDate> <DepositAccountName>string</DepositAccountName> <TransactionID>string</TransactionID> <AuthorizationCode>string</AuthorizationCode> <MerchantAccount>string</MerchantAccount> <MiscCreditCard>string</MiscCreditCard> <CreditCard>Credit Card object</CreditCard> </Payment>
Example:
<Payment> <Amount>50</Amount> <SalesOrderNumber>50032</SalesOrderNumber> <CurrencyRate>5.2</CurrencyRate> <PaymentDate>2019-08-26T00:12:34</PaymentDate> <PaymentMethod>Cash</PaymentMethod> </Payment>
Description: This stores all the information associated with a pick.
Syntax:
<Pick> <PickID>int</PickID> <Number>string</Number> <Type>DB string</Type> <TypeID>DB int</TypeID> <Status>DB string</Status> <StatusID>DB int</StatusID> <Priority>DB string</Priority> <PriorityID>DB int</PriorityID> <LocationGroupID>DB int</LocationGroupID> <DateLastModified>date/time</DateLastModified> <DateScheduled>date/time</DateScheduled> <DateCreated>date/time</DateCreated> <DateStarted>date/time</DateStarted> <DateFinished>date/time</DateFinished> <UserName>DB string</UserName> <PickOrders> <PickOrder> <OrderType>DB string</OrderType> <OrderTypeID>DB int</OrderTypeID> <OrderNum>string</OrderNum> <OrderID>int</OrderID> <OrderTo>DB string</OrderTo> <Note /> </PickOrder> </PickOrders> <PickItems> <PickItem>Pick Item Object</PickItem> </PickItems> </Pick> <Pick> <PickID>1</PickID> <Number>S50007</Number> <Type>Pick</Type> <TypeID>10</TypeID> <Status>Finished</Status> <StatusID>40</StatusID> <Priority>3-Normal</Priority> <PriorityID>30</PriorityID> <LocationGroupID>1</LocationGroupID> <DateLastModified>2019-02-03T09:41:31</DateLastModified> <DateScheduled>2019-11-11T00:00:00</DateScheduled> <DateCreated>2019-02-07T16:13:31</DateCreated> <DateStarted>2019-02-03T09:37:13</DateStarted> <DateFinished>2019-02-03T09:37:13</DateFinished> <UserName>admin</UserName> <PickOrders> <PickOrder> <OrderType>SO</OrderType> <OrderTypeID>20</OrderTypeID> <OrderNum>50007</OrderNum> <OrderID>7</OrderID> <OrderTo>Mountaineer Bikes</OrderTo> <Note /> </PickOrder> </PickOrders> <PickItems> <PickItem> <PickItemID>179</PickItemID> <Status>40</Status> <Part> <PartID>39</PartID> <PartClassID>0</PartClassID> <TypeID>10</TypeID> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <Num>PB3002</Num> <Description>Protein Boost Power Bar</Description> <Details /> <StandardCost>0</StandardCost> <HasBOM>false</HasBOM> <Configurable>false</Configurable> <ActiveFlag>true</ActiveFlag> <SerializedFlag>false</SerializedFlag> <TrackingFlag>true</TrackingFlag> <Weight>2</Weight> <WeightUOM> <UOM> <UOMID>3</UOMID> <Name>Pound</Name> <Code>lbs</Code> <Integral>false</Integral> <Active>true</Active> <Type>Weight</Type> <UOMConversions> <UOMConversion> <MainUOMID>3</MainUOMID> <ToUOMID>8</ToUOMID> <ToUOMCode>kg</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.2046000957489014</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </WeightUOM> <Width>0</Width> <Height>0</Height> <Len>0</Len> <SizeUOM> <UOM> <UOMID>2</UOMID> <Name>Foot</Name> <Code>ft</Code> <Integral>false</Integral> <Active>true</Active> <Type>Length</Type> <UOMConversions> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>7</ToUOMID> <ToUOMCode>in</ToUOMCode> <ConversionMultiply>12.0</ConversionMultiply> <ConversionFactor>1.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>9</ToUOMID> <ToUOMCode>m</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>3.2808001041412354</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </SizeUOM> <UPC /> <PartTrackingList> <PartTracking> <PartTrackingID>3</PartTrackingID> <Name>Expiration Date</Name> <Abbr>ExpDate</Abbr> <Description /> <SortOrder>3</SortOrder> <TrackingTypeID>30</TrackingTypeID> <Active>true</Active> </PartTracking> </PartTrackingList> <VendorPartNums> <VendorPartNumber> <Number>EZ-300-PB</Number> </VendorPartNumber> <VendorPartNumber> <Number>PB3002</Number> </VendorPartNumber> </VendorPartNums> </Part> <Tag> <TagID>0</TagID> <Num>0</Num> <PartNum /> <Location> <LocationID>0</LocationID> <TypeID>0</TypeID> <Name /> <Description /> <CountedAsAvailable>true</CountedAsAvailable> <Active>true</Active> <Pickable>true</Pickable> <Receivable>true</Receivable> <LocationGroupID>0</LocationGroupID> <LocationGroupName /> <TagID>-1</TagID> <TagNumber>-1</TagNumber> </Location> <Quantity>0</Quantity> <QuantityCommitted>0</QuantityCommitted> <WONum>N/A</WONum> <DateCreated>2019-08-17T15:43:51</DateCreated> <Tracking /> <TypeID>30</TypeID> <AccountID>1</AccountID> </Tag> <Quantity>4</Quantity> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <Tracking> <TrackingItem> <PartTracking> <PartTrackingID>3</PartTrackingID> <Name>Expiration Date</Name> <Abbr>ExpDate</Abbr> <Description /> <SortOrder>3</SortOrder> <TrackingTypeID>30</TrackingTypeID> <Active>true</Active> </PartTracking> <TrackingValue>2019-12-08T00:00:00</TrackingValue> </TrackingItem> </Tracking> <DestinationTag> <Tag> <TagID>376</TagID> <Num>363</Num> <PartNum /> <Location> <LocationID>2</LocationID> <TypeID>20</TypeID> <Name>Shipping</Name> <Description>The place where items are packaged and shipped.</Description> <CountedAsAvailable>true</CountedAsAvailable> <Default>true</Default> <Active>true</Active> <Pickable>true</Pickable> <Receivable>true</Receivable> <LocationGroupID>1</LocationGroupID> <LocationGroupName>SLC</LocationGroupName> <SortOrder>10006</SortOrder> <TagID>376</TagID> <TagNumber>363</TagNumber> </Location> <Quantity>0</Quantity> <QuantityCommitted>0</QuantityCommitted> <WONum>N/A</WONum> <DateCreated>2019-08-31T08:16:10</DateCreated> <Tracking /> <TypeID>10</TypeID> <AccountID>1</AccountID> </Tag> </DestinationTag> <OrderType>SO</OrderType> <OrderTypeID>20</OrderTypeID> <OrderNum>50007</OrderNum> <OrderID>7</OrderID> <SoItemId>12</SoItemId> <SlotNumber>1</SlotNumber> <Note /> <Location> <LocationID>7</LocationID> <TypeID>10</TypeID> <Name>Stock 200</Name> <Description>A location within the Stockroom</Description> <CountedAsAvailable>true</CountedAsAvailable> <Active>true</Active> <Pickable>true</Pickable> <Receivable>true</Receivable> <LocationGroupID>1</LocationGroupID> <LocationGroupName>SLC</LocationGroupName> <SortOrder>10011</SortOrder> <TagID>381</TagID> <TagNumber>368</TagNumber> </Location> <PickItemType>10</PickItemType> </PickItem> </PickItems> </Pick>
Description: This stores information about items that are involved in a pick.
Syntax:
<PickItem> <PickItemID>int</PickItemID> <Status>DB int</Status> <Part>Part object</Part> <Tag>Tag object</Tag> <Quantity>int</Quantity> <UOM>UOM object</UOM> <Tracking>Tracking object</Tracking> <DestinationTag> <Tag>Tag object</Tag> </DestinationTag> <OrderType>DB string</OrderType> <OrderTypeID>DB int</OrderTypeID> <OrderNum>DB string</OrderNum> <OrderID>DB int</OrderID> <SoItemId>DB int</SoItemId> <PoItemId>DB int</PoItemId> <XoItemId>DB int</XoItemId> <WoItemId>DB int</WoItemId> <SlotNumber>int</SlotNumber> <Note>string</Note> <Location>Location object</Location> <PickItemType>DB int</PickItemType> </PickItem>
Example:
<PickItem> <PickItemID>179</PickItemID> <Status>40</Status> <Part> <PartID>39</PartID> <PartClassID>0</PartClassID> <TypeID>10</TypeID> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <Num>PB3002</Num> <Description>Protein Boost Power Bar</Description> <Details /> <StandardCost>0</StandardCost> <HasBOM>false</HasBOM> <Configurable>false</Configurable> <ActiveFlag>true</ActiveFlag> <SerializedFlag>false</SerializedFlag> <TrackingFlag>true</TrackingFlag> <Weight>2</Weight> <WeightUOM> <UOM> <UOMID>3</UOMID> <Name>Pound</Name> <Code>lbs</Code> <Integral>false</Integral> <Active>true</Active> <Type>Weight</Type> <UOMConversions> <UOMConversion> <MainUOMID>3</MainUOMID> <ToUOMID>8</ToUOMID> <ToUOMCode>kg</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.2046000957489014</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </WeightUOM> <Width>0</Width> <Height>0</Height> <Len>0</Len> <SizeUOM> <UOM> <UOMID>2</UOMID> <Name>Foot</Name> <Code>ft</Code> <Integral>false</Integral> <Active>true</Active> <Type>Length</Type> <UOMConversions> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>7</ToUOMID> <ToUOMCode>in</ToUOMCode> <ConversionMultiply>12.0</ConversionMultiply> <ConversionFactor>1.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>9</ToUOMID> <ToUOMCode>m</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>3.2808001041412354</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </SizeUOM> <UPC /> <PartTrackingList> <PartTracking> <PartTrackingID>3</PartTrackingID> <Name>Expiration Date</Name> <Abbr>ExpDate</Abbr> <Description /> <SortOrder>3</SortOrder> <TrackingTypeID>30</TrackingTypeID> <Active>true</Active> </PartTracking> </PartTrackingList> <VendorPartNums> <VendorPartNumber> <Number>EZ-300-PB</Number> </VendorPartNumber> <VendorPartNumber> <Number>PB3002</Number> </VendorPartNumber> </VendorPartNums> </Part> <Tag> <TagID>0</TagID> <Num>0</Num> <PartNum /> <Location> <LocationID>0</LocationID> <TypeID>0</TypeID> <Name /> <Description /> <CountedAsAvailable>true</CountedAsAvailable> <Active>true</Active> <Pickable>true</Pickable> <Receivable>true</Receivable> <LocationGroupID>0</LocationGroupID> <LocationGroupName /> <TagID>-1</TagID> <TagNumber>-1</TagNumber> </Location> <Quantity>0</Quantity> <QuantityCommitted>0</QuantityCommitted> <WONum>N/A</WONum> <DateCreated>2019-08-17T15:43:51</DateCreated> <Tracking /> <TypeID>30</TypeID> <AccountID>1</AccountID> </Tag> <Quantity>4</Quantity> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <Tracking> <TrackingItem> <PartTracking> <PartTrackingID>3</PartTrackingID> <Name>Expiration Date</Name> <Abbr>ExpDate</Abbr> <Description /> <SortOrder>3</SortOrder> <TrackingTypeID>30</TrackingTypeID> <Active>true</Active> </PartTracking> <TrackingValue>2019-12-08T00:00:00</TrackingValue> </TrackingItem> </Tracking> <DestinationTag> <Tag> <TagID>376</TagID> <Num>363</Num> <PartNum /> <Location> <LocationID>2</LocationID> <TypeID>20</TypeID> <Name>Shipping</Name> <Description>The place where items are packaged and shipped.</Description> <CountedAsAvailable>true</CountedAsAvailable> <Default>true</Default> <Active>true</Active> <Pickable>true</Pickable> <Receivable>true</Receivable> <LocationGroupID>1</LocationGroupID> <LocationGroupName>SLC</LocationGroupName> <SortOrder>10006</SortOrder> <TagID>376</TagID> <TagNumber>363</TagNumber> </Location> <Quantity>0</Quantity> <QuantityCommitted>0</QuantityCommitted> <WONum>N/A</WONum> <DateCreated>2019-08-31T08:16:10</DateCreated> <Tracking /> <TypeID>10</TypeID> <AccountID>1</AccountID> </Tag> </DestinationTag> <OrderType>SO</OrderType> <OrderTypeID>20</OrderTypeID> <OrderNum>50007</OrderNum> <OrderID>7</OrderID> <SoItemId>12</SoItemId> <SlotNumber>1</SlotNumber> <Note /> <Location> <LocationID>7</LocationID> <TypeID>10</TypeID> <Name>Stock 200</Name> <Description>A location within the Stockroom</Description> <CountedAsAvailable>true</CountedAsAvailable> <Active>true</Active> <Pickable>true</Pickable> <Receivable>true</Receivable> <LocationGroupID>1</LocationGroupID> <LocationGroupName>SLC</LocationGroupName> <SortOrder>10011</SortOrder> <TagID>381</TagID> <TagNumber>368</TagNumber> </Location> <PickItemType>10</PickItemType> </PickItem>
Description: This contains information about a product.
Syntax:
<Product> <ID>DB int</ID> <PartID>DB int</PartID> <Part>Part object</Part> <Num>DB string</Num> <Description>string</Description> <Details /> <UPC /> <SKU /> <Price>price</Price> <UOM>UOM object</UOM> <DefaultSOItemType>DB string (See DB table SOITEMTYPE for options)</DefaultSOItemType> <DisplayType /> <URL /> <Weight>int</Weight> <WeightUOMID>DB int (See UOM table)</WeightUOMID> <Width>int</Width> <Height>int</Height> <Len>int</Len> <SizeUOMID>DB int (See UOM table)</SizeUOMID> <AccountingID /> <AccountingHash /> <SellableInOtherUOMFlag>boolean</SellableInOtherUOMFlag> <ActiveFlag>boolean</ActiveFlag> <TaxableFlag>boolean</TaxableFlag> <UsePriceFlag>boolean</UsePriceFlag> <KitFlag>boolean</KitFlag> <ShowSOComboFlag>boolean</ShowSOComboFlag> <Image>encoded image string</Image> </Product>
Example:
<Product> <ID>52</ID> <PartID>60</PartID> <Part> <PartID>60</PartID> <PartClassID>0</PartClassID> <TypeID>10</TypeID> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <Num>BB2005</Num> <Description>Custom Value Bike</Description> <Details /> <StandardCost>0</StandardCost> <HasBOM>false</HasBOM> <Configurable>true</Configurable> <ActiveFlag>true</ActiveFlag> <SerializedFlag>true</SerializedFlag> <TrackingFlag>true</TrackingFlag> <Weight>0</Weight> <WeightUOM> <UOM> <UOMID>3</UOMID> <Name>Pound</Name> <Code>lbs</Code> <Integral>false</Integral> <Active>true</Active> <Type>Weight</Type> <UOMConversions> <UOMConversion> <MainUOMID>3</MainUOMID> <ToUOMID>8</ToUOMID> <ToUOMCode>kg</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.2046000957489014</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </WeightUOM> <Width>0</Width> <Height>0</Height> <Len>0</Len> <SizeUOM> <UOM> <UOMID>2</UOMID> <Name>Foot</Name> <Code>ft</Code> <Integral>false</Integral> <Active>true</Active> <Type>Length</Type> <UOMConversions> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>7</ToUOMID> <ToUOMCode>in</ToUOMCode> <ConversionMultiply>12.0</ConversionMultiply> <ConversionFactor>1.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>9</ToUOMID> <ToUOMCode>m</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>3.2808001041412354</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </SizeUOM> <UPC /> <PartTrackingList> <PartTracking> <PartTrackingID>4</PartTrackingID> <Name>Serial Number</Name> <Abbr>SN(s)</Abbr> <Description /> <SortOrder>4</SortOrder> <TrackingTypeID>40</TrackingTypeID> <Active>true</Active> <Primary>true</Primary> </PartTracking> </PartTrackingList> </Part> <Num>BB2005</Num> <Description>Custom Value Bike</Description> <Details /> <UPC /> <SKU /> <Price>250</Price> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <DefaultSOItemType>Sale</DefaultSOItemType> <DisplayType>SHOW_ALL</DisplayType> <URL /> <Weight>0</Weight> <WeightUOMID>3</WeightUOMID> <Width>0</Width> <Height>0</Height> <Len>0</Len> <SizeUOMID>2</SizeUOMID> <AccountingID /> <AccountingHash /> <SellableInOtherUOMFlag>true</SellableInOtherUOMFlag> <ActiveFlag>true</ActiveFlag> <TaxableFlag>true</TaxableFlag> <UsePriceFlag>true</UsePriceFlag> <KitFlag>false</KitFlag> <ShowSOComboFlag>true</ShowSOComboFlag> <Image>[B@12b6f63</Image> </Product>
Description: An object used to store data concerning a purchase order.
Updated: 2013.0
Syntax:
<PurchaseOrder> <ID>int</ID> <Note>string</Note> <CreatedDate>date/time</CreatedDate> <FirstShipDate>date/time</FirstShipDate> <Number>PO Number</Number> <Status>ID (10 - Entered, 20 - Picking, 30 - Partial, 40 - Picked, 50 - Fulfilled, 60 – Closed Short, 70 - Void, 45 - Shipped)</Status> <Buyer>string</Buyer> <RemitTo> <Name>string</Name> <AddressField>string</AddressField> <City>string</City> <Zip>string</Zip> <Country>string</Country> <State>string</State> </RemitTo> <Ship> <Name>string</Name> <AddressField>string</AddressField> <City>string</City> <Zip>string</Zip> <Country>string</Country> <State>string</State> </Ship> <DeliverTo /> <ShippingCost>price</ShippingCost> <ShippingTerms>int</ShippingTerms> <PaymentTerms>string</PaymentTerms> <FOB>string</FOB> <VendorContact /> <VendorName>string</VendorName> <VendorSONum /> <QuickBooksClassName>string</QuickBooksClassName> <LocationGroup>string</LocationGroup> <Carrier>string</Carrier> <CurrencyRate>double</CurrencyRate> <CurrencyName>DB string</CurrencyName> <CostIsHomeCurrency>boolean</CostIsHomeCurrency> <Items> <PurchaseOrderItem> <PartNumber>string</PartNumber> <ID>int</ID> <Description>string</Description> <Quantity>int</Quantity> <QuantityFulfilled>int</QuantityFulfilled> <QuantityPicked>int</QuantityPicked> <UOMCode>string</UOMCode> <VendorPartNum>string</VendorPartNum> <ItemType>int</ItemType> <Status>int</Status> <Note /> <UnitCost>price</UnitCost> <QuickBooksClassName>string</QuickBooksClassName> <RevisionLevel /> <ScheduledFulfillmentDate>date/time</ScheduledFulfillmentDate> </PurchaseOrderItem> </Items> </PurchaseOrder>
Example:
<PurchaseOrder> <ID>-1</ID> <Note>Originating Sales Order #50047Originating Notes</Note> <CreatedDate>2019-05-18T14:03:32</CreatedDate> <FirstShipDate>2019-05-18T14:03:32</FirstShipDate> <Number>10070</Number> <Status>10</Status> <Buyer>admin</Buyer> <RemitTo> <Name>Mike's Bikes</Name> <AddressField>2245 South 3000 East</AddressField> <City>Salt Lake City</City> <Zip /> <Country>US</Country> <State>Utah</State> </RemitTo> <Ship> <Name>Bicycles Unlimited</Name> <AddressField>300 W North Temple</AddressField> <City /> <Zip>84103</Zip> <Country>US</Country> <State>Utah</State> </Ship> <DeliverTo /> <ShippingCost>0</ShippingCost> <ShippingTerms>10</ShippingTerms> <PaymentTerms>COD</PaymentTerms> <FOB>Origin</FOB> <VendorContact /> <VendorName>Mike's Bikes</VendorName> <VendorSONum /> <QuickBooksClassName>Salt Lake City</QuickBooksClassName> <LocationGroup>SLC</LocationGroup> <Carrier>Will Call</Carrier> <PurchaseOrderItem> <PartNumber>BB2001</PartNumber> <ID>105</ID> <Description>Mountain Bike</Description> <Quantity>1</Quantity> <QuantityFulfilled>0</QuantityFulfilled> <QuantityPicked>0</QuantityPicked> <UOMCode>ea</UOMCode> <VendorPartNum>BB2001</VendorPartNum> <ItemType>10</ItemType> <Status>10</Status> <Note /> <UnitCost>450</UnitCost> <QuickBooksClassName>Salt Lake City</QuickBooksClassName> <RevisionLevel /> <ScheduledFulfillmentDate>2019-05-18T14:03:32</ScheduledFulfillmentDate> </PurchaseOrderItem> </PurchaseOrder>
Description: This contains receipt information.
Syntax:
<Receipt> <ID>int</ID> <StatusID>DB int</StatusID> <TypeID>DB int</TypeID> <OrderTypeID>DB int</OrderTypeID> <SOID>int</SOID> <POID>int</POID> <XOID>int</XOID> <UserID>int</UserID> <LocationGroupID>DB int</LocationGroupID> <ReceiptItems> <ReceiveItem> <ID>int</ID> <ItemNum>DB string</ItemNum> <Description>string</Description> <LineNum>int</LineNum> <ItemStatus>DB int</ItemStatus> <ItemType>DB int</ItemType> <DateLastModified>date/time</DateLastModified> <OrderNum>string</OrderNum> <OrderType>DB int</OrderType> <SoItemId>int</SoItemId> <PoItemId>int</PoItemId> <XoItemId>int</XoItemId> <OrderItemType>DB int</OrderItemType> <ReceiptID>int</ReceiptID> <Quantity>int</Quantity> <UOMName>DB string</UOMName> <UOMID>DB int</UOMID> <SuggestedLocationID>int</SuggestedLocationID> <OriginalUnitCost>int</OriginalUnitCost> <BilledUnitCost>int</BilledUnitCost> <LandedUnitCost>int</LandedUnitCost> <DeliverTo /> <CarrierID>DB int</CarrierID> <PartTypeID>DB int</PartTypeID> <TrackingNum /> <PackageCount>int</PackageCount> <DateScheduled>date/time</DateScheduled> <ReceivedReceipts> <ReceivedReceipt> <ItemType>DB int</ItemType> <Quantity>int</Quantity> <Reason /> <LocationID>DB int</LocationID> <Tracking /> </ReceivedReceipt> </ReceivedReceipts> <LinkedOrders /> <Part>Part object</Part> </ReceiveItem> </ReceiptItems> </Receipt>
Example:
<Receipt> <ID>92</ID> <StatusID>10</StatusID> <TypeID>20</TypeID> <OrderTypeID>20</OrderTypeID> <SOID>66</SOID> <UserID>1</UserID> <LocationGroupID>1</LocationGroupID> <ReceiptItems> <ReceiveItem> <ID>350</ID> <ItemNum>BTY100-Core</ItemNum> <Description>Battery Pack</Description> <LineNum>2</LineNum> <ItemStatus>10</ItemStatus> <ItemType>1</ItemType> <DateLastModified>2019-08-09T11:05:45</DateLastModified> <OrderNum>500100</OrderNum> <OrderType>20</OrderType> <SoItemId>162</SoItemId> <OrderItemType>20</OrderItemType> <ReceiptID>92</ReceiptID> <Quantity>1</Quantity> <UOMName>Each</UOMName> <UOMID>1</UOMID> <SuggestedLocationID>3</SuggestedLocationID> <OriginalUnitCost>-95</OriginalUnitCost> <BilledUnitCost>-95</BilledUnitCost> <LandedUnitCost>-95</LandedUnitCost> <DeliverTo /> <CarrierID>1</CarrierID> <PartTypeID>10</PartTypeID> <TrackingNum /> <PackageCount>1</PackageCount> <DateScheduled>2019-08-29T00:00:00</DateScheduled> <ReceivedReceipts> <ReceivedReceipt> <ItemType>1</ItemType> <Quantity>1</Quantity> <Reason /> <LocationID>3</LocationID> <Tracking /> </ReceivedReceipt> </ReceivedReceipts> <LinkedOrders /> <Part> <PartID>74</PartID> <PartClassID>0</PartClassID> <TypeID>10</TypeID> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <Num>BTY100</Num> <Description>Battery Pack</Description> <Details /> <StandardCost>0</StandardCost> <HasBOM>false</HasBOM> <Configurable>false</Configurable> <ActiveFlag>true</ActiveFlag> <SerializedFlag>false</SerializedFlag> <TrackingFlag>false</TrackingFlag> <Weight>0</Weight> <WeightUOM> <UOM> <UOMID>3</UOMID> <Name>Pound</Name> <Code>lbs</Code> <Integral>false</Integral> <Active>true</Active> <Type>Weight</Type> <UOMConversions> <UOMConversion> <MainUOMID>3</MainUOMID> <ToUOMID>8</ToUOMID> <ToUOMCode>kg</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.2046000957489014</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </WeightUOM> <Width>0</Width> <Height>0</Height> <Len>0</Len> <SizeUOM> <UOM> <UOMID>2</UOMID> <Name>Foot</Name> <Code>ft</Code> <Integral>false</Integral> <Active>true</Active> <Type>Length</Type> <UOMConversions> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>7</ToUOMID> <ToUOMCode>in</ToUOMCode> <ConversionMultiply>12.0</ConversionMultiply> <ConversionFactor>1.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>9</ToUOMID> <ToUOMCode>m</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>3.2808001041412354</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </SizeUOM> <UPC /> <VendorPartNums> <VendorPartNumber> <Number>BTY100</Number> </VendorPartNumber> </VendorPartNums> </Part> </ReceiveItem> </ReceiptItems> </Receipt>
Description: This contains the details about a report.
Syntax:
<Report> <ID>DB int</ID> <Name>string</Name> <Path>string</Path> <ReportTreeID>DB int</ReportTreeID> <Description>string</Description> <ActiveFlag>boolean</ActiveFlag> <ReadOnly>boolean</ReadOnly> <CreatedDate>date/time</CreatedDate> <DateLastModified>date/time</DateLastModified> <UserID>DB int</UserID> </Report>
Example:
<Report> <ID>164</ID> <Name>New Report</Name> <Path>../reports/Custom/NewReport.jasper</Path> <ReportTreeID>19</ReportTreeID> <Description>Description of the report</Description> <ActiveFlag>true</ActiveFlag> <ReadOnly>false</ReadOnly> <UserID>1</UserID> </Report>
Description: This contains the details about a report tree.
Syntax:
<ReportTree> <ID>DB int</ID> <Name>string</Name> <ParentID>DB int</ParentID> <ReadOnly>boolean</ReadOnly> <UserID>DB int</UserID> </ReportTree>
Example:
<ReportTree> <ID>1</ID> <Name>Company</Name> <ParentID>-1</ParentID> <ReadOnly>true</ReadOnly> <UserID>1</UserID> </ReportTree>
Description: This stores sales order information.
Updated: 2013.1
Syntax:
<SalesOrder> <ID>int</ID> <Note>string</Note> <TotalPrice>double</TotalPrice> <TotalTax>double</TotalTax> <PaymentTotal>double</PaymentTotal> <ItemTotal>double</ItemTotal> <Salesman>string</Salesman> <Number>string</Number> <Status>DB int</Status> <Carrier>DB string</Carrier> <FirstShipDate>date/time</FirstShipDate> <CreatedDate>date/time</CreatedDate> <IssuedDate>date/time</IssuedDate> <TaxRatePercentage>double</TaxRatePercentage> <TaxRateName>string</TaxRateName> <ShippingCost>double</ShippingCost> <ShippingTerms>DB string</ShippingTerms> <PaymentTerms>DB string</PaymentTerms> <CustomerContact>string</CustomerContact> <CustomerName>string</CustomerName> <CustomerID>int</CustomerID> <FOB>DB string</FOB> <QuickBooksClassName>DB string</QuickBooksClassName> <LocationGroup>DB string</LocationGroup> <PriorityId>DB int</PriorityId> <CurrencyRate>double</CurrencyRate> <CurrencyName>DB string</CurrencyName> <PriceIsInHomeCurrency>boolean</PriceIsInHomeCurrency> <BillTo> <Name>string</Name> <AddressField>string</AddressField> <City>string</City> <Zip>string</Zip> <Country>string</Country> <State>string</State> </BillTo> <Ship> <Name>string</Name> <AddressField>string</AddressField> <City>string</City> <Zip>string</Zip> <Country>string</Country> <State>string</State> </Ship> <IssueFlag>boolean</IssueFlag> <VendorPO>string</VendorPO> <CustomerPO>string</CustomerPO> <UPSServiceID>DB int</UPSServiceID> <TotalIncludesTax>boolean</TotalIncludesTax> <TypeID>DB int</TypeID> <URL>string</URL> <Cost>double</Cost> <DateCompleted>date/time</DateCompleted> <DateLastModified>date/time</DateLastModified> <DateRevision>date/time</DateRevision> <RegisterID>int</RegisterID> <ResidentialFlag>boolean</ResidentialFlag> <SalesmanInitials>string</SalesmanInitials> <CustomFields>Custom Field objects</CustomFields> <Memos>Memo objects</Memos> <Items> <SalesOrderItem>Sales Order Item objects</SalesOrderItem> </Items> </SalesOrder>
Example:
<SalesOrder> <Salesman>admin</Salesman> <Number>500100</Number> <Status>20</Status> <Carrier>Will Call</Carrier> <FirstShipDate>2019-08-29T00:00:00</FirstShipDate> <CreatedDate>2019-08-29T00:00:00</CreatedDate> <IssuedDate>2019-08-29T16:48:56</IssuedDate> <TaxRatePercentage>0.0625</TaxRatePercentage> <TaxRateName>Utah</TaxRateName> <ShippingTerms>Prepaid & Billed</ShippingTerms> <PaymentTerms>COD</PaymentTerms> <CustomerContact>Beach Bike</CustomerContact> <CustomerName>Beach Bike</CustomerName> <FOB>Origin</FOB> <QuickBooksClassName>Salt Lake City</QuickBooksClassName> <LocationGroup>SLC</LocationGroup> <PriorityId>30</PriorityId> <BillTo> <Name>Beach Bike</Name> <AddressField>555 Suntan Ave.</AddressField> <City>Santa Barbara</City> <Zip>93101</Zip> </BillTo> <Ship> <Name>Beach Bike</Name> <AddressField>555 Suntan Ave.</AddressField> <Zip>93101</Zip> <Country>US</Country> <State>California</State> </Ship> <Items> <SalesOrderItem> <ID>-1</ID> <ProductNumber>BTY100</ProductNumber> <SOID>93</SOID> <Description>Battery Pack</Description> <Taxable>true</Taxable> <Quantity>1</Quantity> <ProductPrice>95.00</ProductPrice> <TotalPrice>95.00</TotalPrice> <UOMCode>ea</UOMCode> <ItemType>10</ItemType> <Status>10</Status> <QuickBooksClassName>Salt Lake City</QuickBooksClassName> <LineNumber>1</LineNumber> </SalesOrderItem> </Items> </SalesOrder>
Description: This stores sales order item information.
Syntax:
<SalesOrderItem> <ID>int</ID> <ProductNumber>string</ProductNumber> <SOID>int</SOID> <Description>string</Description> <CustomerPartNum>string</CustomerPartNum> <Taxable>boolean</Taxable> <Quantity>int</Quantity> <ProductPrice>int</ProductPrice> <TotalPrice>int</TotalPrice> <UOMCode>DB string</UOMCode> <ItemType>DB int</ItemType> <Status>DB int</Status> <QuickBooksClassName>DB string</QuickBooksClassName> <LineNumber>int</LineNumber> <KitItemFlag>boolean</KitItemFlag> <ShowItemFlag>boolean</ShowItemFlag> <AdjustmentAmount>double</AdjustmentAmount> <AdjustPercentage>int</AdjustPercentage> <DateLastFulfillment>date/time</DateLastFulfillment> <DateLastModified>date/time</DateLastModified> <DateScheduledFulfillment>date/time</DateScheduledFulfillment> <ExchangeSOLineItem>int</ExchangeSOLineItem> <ItemAdjustID>DB int</ItemAdjustID> <QtyFulfilled>int</QtyFulfilled> <QtyPicked>int</QtyPicked> <RevisionLevel>int</RevisionLevel> <TotalCost>double</TotalCost> <TaxableFlag>boolean</TaxableFlag> </SalesOrderItem>
Example:
<SalesOrderItem> <ID>-1</ID> <ProductNumber>BTY100-Core</ProductNumber> <SOID>94</SOID> <Description>Battery Pack</Description> <Taxable>true</Taxable> <Quantity>1</Quantity> <ProductPrice>-95.00</ProductPrice> <TotalPrice>-95.00</TotalPrice> <UOMCode>ea</UOMCode> <ItemType>20</ItemType> <Status>10</Status> <QuickBooksClassName>Salt Lake City</QuickBooksClassName> <LineNumber>2</LineNumber> <KitItemFlag>false</KitItemFlag> <ShowItemFlag>false</ShowItemFlag> <AdjustmentAmount>2.99</AdjustmentAmount> <AdjustPercentage>13</AdjustPercentage> <CustomerPartNum>12345</CustomerPartNum> <DateLastFulfillment>2010-05-18 14 02 21</DateLastFulfillment> <DateLastModified>2010-05-18 14 02 21</DateLastModified> <DateScheduledFulfillment>2010-05-18 14 02 21</DateScheduledFulfillment> <ExchangeSOLineItem>1</ExchangeSOLineItem> <ItemAdjustID>1</ItemAdjustID> <QtyFulfilled>12</QtyFulfilled> <QtyPicked>14</QtyPicked> <RevisionLevel>3</RevisionLevel> <TotalCost>2999.01</TotalCost> <TaxableFlag>true</TaxableFlag> </SalesOrderItem>
Description: This contains the details about a shipment.
Syntax:
<Shipping> <ID>DB int</ID> <OrderNumber>DB int</OrderNumber> <OrderType>DB string</OrderType> <CreatedDate>date/time</CreatedDate> <DateLastModified>date/time</DateLastModified> <Carrier>DB string</Carrier> <Status>DB int</Status> <FOB>Origin</FOB> <Note /> <CartonCount>int</CartonCount> <Address>Address object</Address> <Cartons> <Carton>Carton object</Carton> </Cartons> </Shipping>
Example:
<Shipping> <ID>33</ID> <OrderNumber>50039</OrderNumber> <OrderType>SO</OrderType> <CreatedDate>2019-02-03T10:36:23</CreatedDate> <DateLastModified>2019-02-03T10:36:23</DateLastModified> <Carrier>Will Call</Carrier> <Status>10</Status> <FOB>Origin</FOB> <Note /> <CartonCount>1</CartonCount> <Address> <ID>178</ID> <Attn>Michelle Morris</Attn> <Street>1688 North 1500 West</Street> <City>Island Park</City> <Zip>83429</Zip> <Default>false</Default> <Residential>false</Residential> <Type>Main Office</Type> <State> <ID>15</ID> <Name>Idaho</Name> <Code>ID</Code> <CountryID>2</CountryID> </State> <Country> <ID>2</ID> <Name>UNITED STATES</Name> <Code>US</Code> </Country> </Address> <Cartons> <Carton> <ID>34</ID> <ShipID>33</ShipID> <CartonNum>1</CartonNum> <TrackingNum>514917460800010</TrackingNum> <FreightWeight>18</FreightWeight> <FreightAmount>11.3</FreightAmount> <ShippingItems> <ShippingItem> <ShipItemID>89</ShipItemID> <ProductNumber>SP001</ProductNumber> <ProductDescription>Replacement Spokes</ProductDescription> <QtyShipped>100</QtyShipped> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <Cost>0</Cost> <SKU /> <UPC /> <SoItemId>116</SoItemId> <OrderLineItem>1</OrderLineItem> <CartonName>1</CartonName> <CartonID>34</CartonID> <Weight>0</Weight> <WeightUOM> <UOM> <UOMID>3</UOMID> <Name>Pound</Name> <Code>lbs</Code> <Integral>false</Integral> <Active>true</Active> <Type>Weight</Type> <UOMConversions> <UOMConversion> <MainUOMID>3</MainUOMID> <ToUOMID>8</ToUOMID> <ToUOMCode>kg</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.2046000957489014</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </WeightUOM> <DisplayWeight>0</DisplayWeight> <DisplayWeightUOM> <UOM> <UOMID>3</UOMID> <Name>Pound</Name> <Code>lbs</Code> <Integral>false</Integral> <Active>true</Active> <Type>Weight</Type> <UOMConversions> <UOMConversion> <MainUOMID>3</MainUOMID> <ToUOMID>8</ToUOMID> <ToUOMCode>kg</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.2046000957489014</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </DisplayWeightUOM> <Tracking /> </ShippingItem> </ShippingItems> </Carton> </Cartons> </Shipping>
Description: A number that helps describe a location.
Syntax:
<Tag> <TagID>int</TagID> <Num>int</Num> <PartNum /> <Location>Location object</Location> <Quantity>int</Quantity> <QuantityCommitted>int</QuantityCommitted> <WONum>DB string</WONum> <DateCreated>date/time</DateCreated> <Tracking /> <TypeID>DB int</TypeID> <AccountID>DB int</AccountID> </Tag>
Example:
<Tag> <TagID>376</TagID> <Num>363</Num> <PartNum /> <Location> <LocationID>2</LocationID> <TypeID>20</TypeID> <Name>Shipping</Name> <Description>The place where items are packaged and shipped.</Description> <CountedAsAvailable>true</CountedAsAvailable> <Default>true</Default> <Active>true</Active> <Pickable>true</Pickable> <Receivable>true</Receivable> <LocationGroupID>1</LocationGroupID> <LocationGroupName>SLC</LocationGroupName> <SortOrder>10006</SortOrder> <TagID>376</TagID> <TagNumber>363</TagNumber> </Location> <Quantity>0</Quantity> <QuantityCommitted>0</QuantityCommitted> <WONum>N/A</WONum> <DateCreated>2019-08-31T08:16:10</DateCreated> <Tracking /> <TypeID>10</TypeID> <AccountID>1</AccountID> </Tag>
Description: This stores tax rate information.
Syntax:
<TaxRate> <ID>int</ID> <Name>string</Name> <Description>string</Description> <Rate>double</Rate> <TypeID>DB int</TypeID> <VendorID>DB int</VendorID> <DefaultFlag>boolean</DefaultFlag> <ActiveFlag>boolean</ActiveFlag> </TaxRate>
Example:
<TaxRate> <ID>2</ID> <Name>Tax</Name> <Description /> <Rate>.05</Rate> <TypeID>10</TypeID> <VendorID>6</VendorID> <DefaultFlag>true</DefaultFlag> <ActiveFlag>true</ActiveFlag> </TaxRate>
Description: This simply contains the TrackingItem objects that contain the information being tracked.
Syntax:
<Tracking>Tracking Item object</Tracking>
Example:
<Tracking> <TrackingItem> <PartTracking> <PartTrackingID>3</PartTrackingID> <Name>Expiration Date</Name> <Abbr>ExpDate</Abbr> <Description /> <SortOrder>3</SortOrder> <TrackingTypeID>30</TrackingTypeID> <Active>true</Active> </PartTracking> <TrackingValue>2019-12-08T00:00:00</TrackingValue> </TrackingItem> </Tracking>
Description: This object contains the information being tracked.
Syntax:
<TrackingItem> <PartTracking> <PartTrackingID>int</PartTrackingID> <Name>string</Name> <Abbr>string</Abbr> <Description /> <SortOrder>int</SortOrder> <TrackingTypeID>DB int</TrackingTypeID> <Active>boolean</Active> </PartTracking> <TrackingValue>int / double / string / date</TrackingValue> </TrackingItem>
Example:
<TrackingItem> <PartTracking> <PartTrackingID>3</PartTrackingID> <Name>Expiration Date</Name> <Abbr>ExpDate</Abbr> <Description /> <SortOrder>3</SortOrder> <TrackingTypeID>30</TrackingTypeID> <Active>true</Active> </PartTracking> <TrackingValue>2019-12-08T00:00:00</TrackingValue> </TrackingItem>
Description: This contains unit of measure details.
Syntax:
<UOM> <UOMID>DB int</UOMID> <Name>string</Name> <Code>DB string</Code> <Integral>boolean</Integral> <Active>boolean</Active> <Type>DB string</Type> <UOMConversions> <UOMConversion>UOM Conversion object</UOMConversion> </UOMConversions> </UOM>
Example:
<UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM>
Description: This stores conversion information for a unit of measure.
Syntax:
<UOMConversion> <MainUOMID>DB int</MainUOMID> <ToUOMID>DB int</ToUOMID> <ToUOMCode>DB string</ToUOMCode> <ConversionMultiply>double</ConversionMultiply> <ConversionFactor>double</ConversionFactor> <ToUOMIsIntegral>boolean</ToUOMIsIntegral> </UOMConversion>
Example:
<UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion>
Description: User details.
Syntax:
<User> <ID>int</ID> <UserName>string</UserName> <FirstName>string</FirstName> <LastName>string</LastName> <Initials>string</Initials> <Active>boolean</Active> </User>
Example:
<User> <ID>1</ID> <UserName>admin</UserName> <FirstName>Administrator</FirstName> <LastName>Administrator</LastName> <Initials>ADM</Initials> <Active>true</Active> </User>
Description: This contains all the vendor information and details.
Syntax:
<Vendor> <VendorID>int</VendorID> <AccountID>int</AccountID> <Status>string</Status> <DefPaymentTerms>string</DefPaymentTerms> <DefShipTerms>string</DefShipTerms> <TaxRate>string</TaxRate> <Name>string</Name> <Number>string</Number> <DateCreated>date/time</DateCreated> <DateModified>date/time</DateModified> <LastChangedUser>string</LastChangedUser> <CreditLimit>price</CreditLimit> <Note>string</Note> <AysUserID>int</AysUserID> <ActiveFlag>boolean</ActiveFlag> <AccountingID>string</AccountingID> <AccountingHash>string</AccountingHash> <CurrencyName>DB string</CurrencyName> <CurrencyRate>double</CurrencyRate> <LeadTime>int</LeadTime> <Addresses>Address objects</Addresses> <CustomFields>Custom Field objects</CustomFields> </Vendor>
Example:
<Vendor> <VendorID>8</VendorID> <AccountID>206</AccountID> <Status>Normal</Status> <DefPaymentTerms>COD</DefPaymentTerms> <DefShipTerms>Prepaid & Billed</DefShipTerms> <Name>A&B Distribution</Name> <Number>5</Number> <DateCreated>2019-02-07T14:31:34</DateCreated> <DateModified>2019-03-09T13:41:06</DateModified> <LastChangedUser>admin</LastChangedUser> <CreditLimit>0</CreditLimit> <Note /> <ActiveFlag>true</ActiveFlag> <AccountingID>67265</AccountingID> <AccountingHash>12345</AccountingHash> <Addresses /> </Vendor>
Description: This contains the number that a vendor uses to refer to a part that you may reference differently. A value is required in order to create a valid object.
Syntax:
<VendorPartNumber>
<Number>string</Number>
</VendorPartNumber>
Example:
<VendorPartNumber> <Number>B16-76876</Number> </VendorPartNumber>
Description: This contains all the work order information and details.
Syntax:
<WO> <ID>int</ID> <Num>string</Num> <Type>DB String</Type> <TypeID>DB int</TypeID> <MOItemID>DB int</MOItemID> <WOItems> <WOItem>Work Order Item object</WOItem> </WOItems> <Cost>int</Cost> <Location> <Location>Location object</Location> </Location> <LocationGroup>Location Group object</LocationGroup> <Note /> <StatusID>DB int</StatusID> <QBClass>DB string</QBClass> <QBClassID>DB int</QBClassID> <QtyOrdered>int</QtyOrdered> <QtyTarget>int</QtyTarget> <DateCreated>date/time</DateCreated> <DateFinished>date/time</DateFinished> <DateLastModified>date/time</DateLastModified> <DateScheduled>date/time</DateScheduled> <DateStarted>date/time</DateStarted> <User>User object</User> </WO>
Example:
<WO> <ID>1</ID> <Num>1 001</Num> <Type>Manufacture</Type> <TypeID>6</TypeID> <MOItemID>1</MOItemID> <WOItems> <WOItem> <ID>1</ID> <MOItemID>2</MOItemID> <TypeID>10</TypeID> <Part> <PartID>36</PartID> <PartClassID>0</PartClassID> <TypeID>10</TypeID> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <Num>BB2002</Num> <Description>Comfort Bike</Description> <Details /> <StandardCost>0</StandardCost> <HasBOM>false</HasBOM> <Configurable>false</Configurable> <ActiveFlag>true</ActiveFlag> <SerializedFlag>true</SerializedFlag> <TrackingFlag>true</TrackingFlag> <Weight>20</Weight> <WeightUOM> <UOM> <UOMID>3</UOMID> <Name>Pound</Name> <Code>lbs</Code> <Integral>false</Integral> <Active>true</Active> <Type>Weight</Type> <UOMConversions> <UOMConversion> <MainUOMID>3</MainUOMID> <ToUOMID>8</ToUOMID> <ToUOMCode>kg</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.2046000957489014</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </WeightUOM> <Width>0</Width> <Height>0</Height> <Len>0</Len> <SizeUOM> <UOM> <UOMID>2</UOMID> <Name>Foot</Name> <Code>ft</Code> <Integral>false</Integral> <Active>true</Active> <Type>Length</Type> <UOMConversions> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>7</ToUOMID> <ToUOMCode>in</ToUOMCode> <ConversionMultiply>12.0</ConversionMultiply> <ConversionFactor>1.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>9</ToUOMID> <ToUOMCode>m</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>3.2808001041412354</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </SizeUOM> <UPC /> <PartTrackingList> <PartTracking> <PartTrackingID>4</PartTrackingID> <Name>Serial Number</Name> <Abbr>SN(s)</Abbr> <Description /> <SortOrder>4</SortOrder> <TrackingTypeID>40</TrackingTypeID> <Active>true</Active> <Primary>true</Primary> </PartTracking> </PartTrackingList> <VendorPartNums> <VendorPartNumber> <Number>BB2002</Number> </VendorPartNumber> <VendorPartNumber> <Number>BB2002</Number> </VendorPartNumber> </VendorPartNums> </Part> <Description>Create BB2002</Description> <Cost>$0.00</Cost> <DateScheduled>2019-11-04T00:00:00</DateScheduled> <InstructionNote /> <InstructionURL /> <QtyScrapped>0</QtyScrapped> <QtyToFulfill>1</QtyToFulfill> <QtyUsed>1</QtyUsed> <DestLocation> <Location> <LocationID>10</LocationID> <TypeID>70</TypeID> <Name>Store Front</Name> <Description>Point of Sale location</Description> <CountedAsAvailable>true</CountedAsAvailable> <Default>true</Default> <Active>true</Active> <Pickable>true</Pickable> <Receivable>true</Receivable> <LocationGroupID>1</LocationGroupID> <LocationGroupName>SLC</LocationGroupName> <SortOrder>10013</SortOrder> <TagID>384</TagID> <TagNumber>371</TagNumber> </Location> </DestLocation> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <Tracking /> <SortID>1</SortID> </WOItem> </WOItems> <Cost>0</Cost> <Location> <Location> <LocationID>9</LocationID> <TypeID>80</TypeID> <Name>Manufacturing</Name> <Description>The place where things are Manufactured</Description> <CountedAsAvailable>true</CountedAsAvailable> <Default>true</Default> <Active>true</Active> <Pickable>true</Pickable> <Receivable>true</Receivable> <LocationGroupID>1</LocationGroupID> <LocationGroupName>SLC</LocationGroupName> <SortOrder>10004</SortOrder> <TagID>383</TagID> <TagNumber>370</TagNumber> </Location> </Location> <LocationGroup> <LocationGroup> <LocationGroupID>1</LocationGroupID> <LocationGroupName>SLC</LocationGroupName> <DefaultQBClassID>2</DefaultQBClassID> </LocationGroup> </LocationGroup> <Note /> <StatusID>40</StatusID> <QBClass>None</QBClass> <QBClassID>1</QBClassID> <QtyOrdered>1</QtyOrdered> <QtyTarget>1</QtyTarget> <DateCreated>2019-11-04T16:59:40</DateCreated> <DateFinished>2019-11-04T17:01:07</DateFinished> <DateLastModified>2019-11-04T17:01:07</DateLastModified> <DateScheduled>2019-11-04T00:00:00</DateScheduled> <DateStarted>2019-11-04T16:59:40</DateStarted> <User> <User> <ID>1</ID> <UserName>admin</UserName> <FirstName>Administrator</FirstName> <LastName>Administrator</LastName> <Initials>ADM</Initials> <Active>true</Active> </User> </User> </WO>
Description: This stores information about an item found in a work order.
Syntax:
<WOItem> <ID>int</ID> <MOItemID>DB int</MOItemID> <TypeID>DB int</TypeID> <Part>Part object</Part> <Description>string</Description> <Cost>string</Cost> <DateScheduled>2019-11-04T00:00:00</DateScheduled> <InstructionNote /> <InstructionURL /> <QtyScrapped>int</QtyScrapped> <QtyToFulfill>int</QtyToFulfill> <QtyUsed>int</QtyUsed> <DestLocation> <Location>Location object</Location> </DestLocation> <UOM>UOM object</UOM> <Tracking /> <SortID>int</SortID> </WOItem>
Example:
<WOItem> <ID>1</ID> <MOItemID>2</MOItemID> <TypeID>10</TypeID> <Part> <PartID>36</PartID> <PartClassID>0</PartClassID> <TypeID>10</TypeID> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <Num>BB2002</Num> <Description>Comfort Bike</Description> <Details /> <StandardCost>0</StandardCost> <HasBOM>false</HasBOM> <Configurable>false</Configurable> <ActiveFlag>true</ActiveFlag> <SerializedFlag>true</SerializedFlag> <TrackingFlag>true</TrackingFlag> <Weight>20</Weight> <WeightUOM> <UOM> <UOMID>3</UOMID> <Name>Pound</Name> <Code>lbs</Code> <Integral>false</Integral> <Active>true</Active> <Type>Weight</Type> <UOMConversions> <UOMConversion> <MainUOMID>3</MainUOMID> <ToUOMID>8</ToUOMID> <ToUOMCode>kg</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.2046000957489014</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </WeightUOM> <Width>0</Width> <Height>0</Height> <Len>0</Len> <SizeUOM> <UOM> <UOMID>2</UOMID> <Name>Foot</Name> <Code>ft</Code> <Integral>false</Integral> <Active>true</Active> <Type>Length</Type> <UOMConversions> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>7</ToUOMID> <ToUOMCode>in</ToUOMCode> <ConversionMultiply>12.0</ConversionMultiply> <ConversionFactor>1.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>9</ToUOMID> <ToUOMCode>m</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>3.2808001041412354</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </SizeUOM> <UPC /> <PartTrackingList> <PartTracking> <PartTrackingID>4</PartTrackingID> <Name>Serial Number</Name> <Abbr>SN(s)</Abbr> <Description /> <SortOrder>4</SortOrder> <TrackingTypeID>40</TrackingTypeID> <Active>true</Active> <Primary>true</Primary> </PartTracking> </PartTrackingList> <VendorPartNums> <VendorPartNumber> <Number>BB2002</Number> </VendorPartNumber> <VendorPartNumber> <Number>BB2002</Number> </VendorPartNumber> </VendorPartNums> </Part> <Description>Create BB2002</Description> <Cost>$0.00</Cost> <DateScheduled>2019-11-04T00:00:00</DateScheduled> <InstructionNote /> <InstructionURL /> <QtyScrapped>0</QtyScrapped> <QtyToFulfill>1</QtyToFulfill> <QtyUsed>1</QtyUsed> <DestLocation> <Location> <LocationID>10</LocationID> <TypeID>70</TypeID> <Name>Store Front</Name> <Description>Point of Sale location</Description> <CountedAsAvailable>true</CountedAsAvailable> <Default>true</Default> <Active>true</Active> <Pickable>true</Pickable> <Receivable>true</Receivable> <LocationGroupID>1</LocationGroupID> <LocationGroupName>SLC</LocationGroupName> <SortOrder>10013</SortOrder> <TagID>384</TagID> <TagNumber>371</TagNumber> </Location> </DestLocation> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <Tracking /> <SortID>1</SortID> </WOItem>
REQUESTS
Description: This adds the initial inventory of a part.
Added: 2011.4
Syntax:
<AddInventoryRq> <PartNum>string</PartNum> <Quantity>int</Quantity> <UOMID>int</UOMID> <Cost>price</Cost> <Note>string</Note> <Tracking>Tracking object</Tracking> <LocationTagNum>int</LocationTagNum> <TagNum>int</TagNum> </AddInventoryRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <AddInventoryRq> <PartNum>B201</PartNum> <Quantity>5</Quantity> <UOMID>1</UOMID> <Cost>25.00</Cost> <Note>Initial inventory for B201</Note> <LocationTagNum>106</LocationTagNum> <TagNum>0</TagNum> </AddInventoryRq> </FbiMsgsRq> </FbiXml>
Description: This adds a memo to the specified object.
Added: 2014.0
Syntax:
<AddMemoRq> <ItemType>Part, Product, Customer, Vendor, SO, PO, TO, MO, RMA, BOM</ItemType> <PartNum>string</PartNum> <ProductNum>string</ProductNum> <OrderNum>string</OrderNum> <CustomerNum>string</CustomerNum> <VendorNum>string</VendorNum> <Memo>Memo object</Memo> </AddMemoRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <AddMemoRq> <ItemType>Part</ItemType> <PartNum>B201</PartNum> <Memo> <Memo>This is a test</Memo> <UserName>admin</UserName> </Memo> </AddMemoRq> </FbiMsgsRq> </FbiXml>
Description: This adds an item to a sales order.
Added: 2012.3
Syntax:
<AddSOItemRq> <OrderNum>string</OrderNum> <SalesOrderItem>Sales Order Item object</SalesOrderItem> </AddSOItemRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <AddSOItemRq> <OrderNum>50050</OrderNum> <SalesOrderItem> <ID>-1</ID> <ProductNumber>BTY100-Core</ProductNumber> <SOID>94</SOID> <Description>Battery Pack</Description> <Taxable>true</Taxable> <Quantity>1</Quantity> <ProductPrice>-95.00</ProductPrice> <TotalPrice>-95.00</TotalPrice> <UOMCode>ea</UOMCode> <ItemType>20</ItemType> <Status>10</Status> <QuickBooksClassName>Salt Lake City</QuickBooksClassName> </SalesOrderItem> </AddSOItemRq> </FbiMsgsRq> </FbiXml>
Description: This adds an item to an existing open WO.
Added: 2015.2
Syntax:
<AddWorkOrderItemRq> <OrderNum>string</OrderNum> <TypeId>DB int</TypeId> <Description>string</Description> <PartNum>string</PartNum> <Quantity>int</Quantity> <UOMCode>string</UOMCode> <Cost>Money</Cost> </AddWorkOrderItemRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <AddWorkOrderItemRq> <OrderNum>502 001</OrderNum> <Description>This will create a note item.</Description> </AddWorkOrderItemRq> </FbiMsgsRq> </FbiXml>
Description: This creates an MO for a specific BOM number.
Added: 2016.3
Syntax:
<BuildBomRq> <BomNumber>string</BomNumber> <Quantity>int</Quantity> <DateScheduled>Date</DateScheduled> </BuildBomRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <BuildBomRq> <BomNumber>BB2001</BomNumber> <Quantity>1</Quantity> <DateScheduled>2015-12-28 00 00 00</DateScheduled> </BuildBomRq> </FbiMsgsRq> </FbiXml>
Description: This generates a shipping order that is completely fictitious. You would use this request to calculate the cost, etc. If you want to actually process this order, you need to use the Save button.
Syntax:
<CalculateSORq>
<SalesOrder>Sales Order object</SalesOrder>
</CalculateSORq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <CalculateSORq> <SalesOrder> <Salesman>admin</Salesman> <Number>500100</Number> <Status>20</Status> <Carrier>Will Call</Carrier> <FirstShipDate>2019-08-29T00:00:00</FirstShipDate> <CreatedDate>2019-08-29T00:00:00</CreatedDate> <IssuedDate>2019-08-29T16:48:56</IssuedDate> <TaxRatePercentage>0.0625</TaxRatePercentage> <TaxRateName>Utah</TaxRateName> <ShippingTerms>Prepaid & Billed</ShippingTerms> <PaymentTerms>COD</PaymentTerms> <CustomerContact>Beach Bike</CustomerContact> <CustomerName>Beach Bike</CustomerName> <FOB>Origin</FOB> <QuickBooksClassName>Salt Lake City</QuickBooksClassName> <LocationGroup>SLC</LocationGroup> <BillTo> <Name>Beach Bike</Name> <AddressField>555 Suntan Ave.</AddressField> <City>Santa Barbara</City> <Zip>93101</Zip> </BillTo> <Ship> <Name>Beach Bike</Name> <AddressField>555 Suntan Ave.</AddressField> <Zip>93101</Zip> <Country>US</Country> <State>California</State> </Ship> <SalesOrderItem> <ID>-1</ID> <ProductNumber>BTY100</ProductNumber> <SOID>93</SOID> <Description>Battery Pack</Description> <Taxable>true</Taxable> <Quantity>1</Quantity> <ProductPrice>95.00</ProductPrice> <TotalPrice>95.00</TotalPrice> <UOMCode>ea</UOMCode> <ItemType>10</ItemType> <Status>10</Status> <QuickBooksClassName>Salt Lake City</QuickBooksClassName> <LineNumber>1</LineNumber> </SalesOrderItem> <SalesOrderItem> <ID>-1</ID> <ProductNumber>BTY100-Core</ProductNumber> <SOID>94</SOID> <Description>Battery Pack</Description> <Taxable>true</Taxable> <Quantity>1</Quantity> <ProductPrice>-95.00</ProductPrice> <TotalPrice>-95.00</TotalPrice> <UOMCode>ea</UOMCode> <ItemType>20</ItemType> <Status>10</Status> <QuickBooksClassName>Salt Lake City</QuickBooksClassName> <LineNumber>2</LineNumber> </SalesOrderItem> </SalesOrder> </CalculateSORq> </FbiMsgsRq> </FbiXml>
Description: This returns the names of every Carrier in your database.
Syntax:
<CarrierListRq />
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <CarrierListRq /> </FbiMsgsRq> </FbiXml>
Description: This request is used to close short a sales order.
Syntax:
<CloseShortSORq>SO Number</CloseShortSORq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <CloseShortSORq> <SONumber>50069</SONumber> </CloseShortSORq> </FbiMsgsRq> </FbiXml>
Description: This returns a Customer object from your database with all the data associated with that customer. Note: When currency rate is 0, then customer is using the default currency rate.
Syntax:
<CustomerGetRq>
<Name>Customer Name</Name>
</CustomerGetRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <CustomerGetRq> <Name>Nancy Bluer</Name> </CustomerGetRq> </FbiMsgsRq> </FbiXml>
Description: This returns a list of every Customer in your database with their details.
Syntax:
<CustomerListRq />
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <CustomerListRq /> </FbiMsgsRq> </FbiXml>
Description: This returns a list of the names of all the customers in your database.
Syntax:
<CustomerNameListRq />
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <CustomerNameListRq /> </FbiMsgsRq> </FbiXml>
Description: This is used to correct inventory amounts. Including tracking information is optional.
Syntax:
<CycleCountRq> <PartNum>DB int</PartNum> <Quantity>int</Quantity> <LocationID>DB int</LocationID> <Tracking>string</Tracking> </CycleCountRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <CycleCountRq> <PartNum>B200</PartNum> <Quantity>10</Quantity> <LocationID>1</LocationID> </CycleCountRq> </FbiMsgsRq> </FbiXml>
Description: This emails a report to a given email address (Date ranges cannot be specified).
Added: 2015.3
Syntax:
<EmailReportRq> <ReportName>string</ReportName> <ReportTree>string</ReportTree> <Email>string</Email> <ParameterList> <ReportParam> <Name>string</Name> <Value>string</Value> </ReportParam> </ParameterList> </EmailReportRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <EmailReportRq> <ReportName>Sales Order Summary</ReportName> <ReportTree>Sales Order</ReportTree> <Email>user@email.com</Email> <ParameterList> <ReportParam> <Name>soNum</Name> <Value>50055</Value> </ReportParam> </ParameterList> </EmailReportRq> </FbiMsgsRq> </FbiXml>
Description: This returns all available export options.
Syntax:
<ExportListRq />
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <ExportListRq /> </FbiMsgsRq> </FbiXml>
Description: This returns export data of the specified export type.
Syntax:
<ExportRq>
<Type>DB string</Type>
</ExportRq>
Example:
<ExportRq> <Type>ExportPartCost</Type> </ExportRq>
Description: This returns results of sql query in csv format. Two options are available. A query that has been saved in the Fishbowl Client Data module can be executed using <Name>, or a query can be placed directly in the call using <Query>.
Added: 2015.0 Syntax:
<ExecuteQueryRq> <Name>DB string</Name>(optional) <Query>DB string</Query>(optional) </ExecuteQueryRq>
Example:
<ExecuteQueryRq> <Name>PartList</Name> </ExecuteQueryRq> <ExecuteQueryRq> <Query>SELECT part.num AS partNumber, part.description AS partDescription FROM part</Query> </ExecuteQueryRq>
Description: This returns a list of all QuickBooks accounts complete with IDs, types, and balances.
Syntax:
<GetAccountListRq />
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <GetAccountListRq /> </FbiMsgsRq> </FbiXml>
Description: This request will return the information on the specified pick.
Syntax:
<GetPartListRq> <PartNum>DB string</PartNum> <PartDesc>string</PartDesc> <PartDetails>string</PartDetails> <PartUPC>string</PartUPC> <PartType>DB string</PartType> <ABCCode>string</ABCCode> <VendorName>DB string</VendorName> <VendorNum>string</VendorNum> <ProductNum>DB string</ProductNum> <ProductDesc>string</ProductDesc> <ActiveFlag>boolean</ActiveFlag> <ShowActive>boolean</ShowActive> <ShowInactive>boolean</ShowInactive> <HasBOM>boolean</HasBOM> <Configurable>boolean</Configurable> </GetPartListRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <GetPartListRq> <PartNum>B201</PartNum> </GetPartListRq> </FbiMsgsRq> </FbiXml>
Description: This request will return the information on the specified pick.
Syntax:
<GetPickRq>
<PickNum>DB string</PickNum>
</GetPickRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <GetPickRq> <PickNum>S50023-11</PickNum> </GetPickRq> </FbiMsgsRq> </FbiXml>
Description: This returns all purchase orders queued in the specified location.
Syntax:
<GetPOListRq>
<LocationGroup>DB string</LocationGroup>
</GetPOListRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <GetPOListRq> <LocationGroup>SLC</LocationGroup> </GetPOListRq> </FbiMsgsRq> </FbiXml>
Description: This returns receipt information.
Syntax:
<GetReceiptRq> <OrderNumber>DB string</OrderNumber> <OrderType>DB int</OrderType> <LocationGroup>DB int</LocationGroup> </GetReceiptRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <GetReceiptRq> <OrderNumber>500100</OrderNumber> <OrderType>20</OrderType> <LocationGroup>1</LocationGroup> </GetReceiptRq> </FbiMsgsRq> </FbiXml>
Description: This requests a list of shipments. This includes all those that have been shipped. Be sure to include more specifics on what you want to see. Note: You cannot use Order Number in conjunction with Order Type and Carrier. Order Number returns the history of the use of that number, see Example 2. Also, to merit a response, you must include the RecordCount field.
Syntax:
<GetShipListRq> <StartRecord>int</StartRecord> <RecordCount>int</RecordCount> <OrderNumber>int</OrderNumber> <OrderTypeID>DB int</OrderTypeID> <LocationGroup>DB int</LocationGroup> <Carrier>DB int</Carrier> </GetShipListRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <GetShipListRq> <StartRecord>0</StartRecord> <RecordCount>10</RecordCount> <OrderTypeID>20</OrderTypeID> <StatusID>20</StatusID> <LocationGroup>1</LocationGroup> <Carrier>20</Carrier> </GetShipListRq> </FbiMsgsRq> </FbiXml>
Description: This returns the shipment details about the specified shipment.
Syntax:
<GetShipmentRq> <ShipmentID>int</ShipmentID> <ShipmentNum>string</ShipmentNum> </GetShipmentRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <GetShipmentRq> <ShipmentNum>S50039</ShipmentNum> </GetShipmentRq> </FbiMsgsRq> </FbiXml>
Description: This returns a list of orders that are packed and ready to ship.
Syntax:
<GetShipNowListRq> <LocationGroup>string</LocationGroup> <Carrier> <Name>string</Name> </Carrier> </GetShipNowListRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <GetShipNowListRq> <LocationGroup>SLC</LocationGroup> <Carrier> <Name>UPS</Name> </Carrier> </GetShipNowListRq> </FbiMsgsRq> </FbiXml>
Description: This returns a detailed list of SOs (sales orders) based on the search parameters.
Updated: 2015.4
Syntax:
<GetSOListRq> <SONum>string</SONum> <LocationGroup>DB int</LocationGroup> <Status>string</Status> <CustomerPO>string</CustomerPO> <CustomerName>string</CustomerName> <AccountNumber>string</AccountNumber> <BillTo>string</BillTo> <ShipTo>string</ShipTo> <ProductNum>string</ProductNum> <ProductDesc>string</ProductDesc> <ProductDetails>string</ProductDetails> <Salesman>string</Salesman> <Type>string</Type> <DateIssuedBegin>date</DateIssuedBegin> <DateIssuedEnd>date</DateIssuedEnd> <DateCreatedBegin>date</DateCreatedBegin> <DateCreatedEnd>date</DateCreatedEnd> <DateLasteModifiedBegin>date</DateLasteModifiedBegin> <DateLasteModifiedEnd>date</DateLasteModifiedEnd> <DateScheduledBegin>date</DateScheduledBegin> <DateScheduledEnd>date</DateScheduledEnd> <DateCompletedBegin>date</DateCompletedBegin> <DateCompletedEnd>date</DateCompletedEnd> </GetSOListRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <GetSOListRq> <LocationGroup>SLC</LocationGroup> </GetSOListRq> </FbiMsgsRq> </FbiXml>
Description: This returns the total number of the inquired item at a specific location.
Syntax:
<GetTotalInventoryRq> <PartNumber>string</PartNumber> <LocationGroup>DB string</LocationGroup> </GetTotalInventoryRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <GetTotalInventoryRq> <PartNumber>B201</PartNumber> <LocationGroup>SLC</LocationGroup> </GetTotalInventoryRq> </FbiMsgsRq> </FbiXml>
Description: This request returns a list of your import options.
Syntax:
<ImportListRq />
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <ImportListRq /> </FbiMsgsRq> </FbiXml>
Description: This request allows you to import data. The example uses the import to edit/add a vendor. Data columns can be blank, but each data column must be represented in the request. It is a best practice to always include the header rows when importing data.
Syntax:
<ImportRq> <Type>DB string</Type> <Rows> <Row>Data for each column required by the type</Row> </Rows> </ImportRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <ImportRq> <Type>ImportVendors</Type> <Rows> <Row>"Monroe Bike Company","Williams Bike Company - 210","Williams Bike Company","50","true","Wall st.","New York","NY","21004","UNITED STATES","212-321-5643",,,,,,,,,,,,,</Row> </Rows> </ImportRq> </FbiMsgsRq> </FbiXml>
Description: This request allows you to get the headers of an import. The example retrieves the import headers of the Add Inventory import.
Added: 2016.8
Syntax:
<ImportHeaderRq> <Type>ImportAddInventory</Type> </ImportHeaderRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <ImportHeaderRq> <Type>ImportAddInventory</Type> </ImportHeaderRq> </FbiMsgsRq> </FbiXml>
Description: This returns details and quantity of the specified Part or list of parts modified within the given date range.
Syntax:
<InvQtyRq> <PartNum>DB string</PartNum> <LastModifiedFrom>Date</LastModifiedFrom> <LastModifiedTo>Date</LastModifiedTo> </InvQtyRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <InvQtyRq> <PartNum /> <LastModifiedFrom>2019-02-03T10:04:27</LastModifiedFrom> <LastModifiedTo>2019-02-03T10:04:27</LastModifiedTo> </InvQtyRq> </FbiMsgsRq> </FbiXml>
Description: This will issue a sales order.
Syntax:
<IssueSORq>
<SONumber>string</SONumber>
</IssueSORq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <IssueSORq> <SONumber>50067</SONumber> </IssueSORq> </FbiMsgsRq> </FbiXml>
Description: This returns a simple list of parts.
Syntax:
<LightPartListRq />
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <LightPartListRq /> </FbiMsgsRq> </FbiXml>
Description: This will return information about the specified sales order.
Syntax:
<LoadSORq>
<Number>string</Number>
</LoadSORq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <LoadSORq> <Number>50024</Number> </LoadSORq> </FbiMsgsRq> </FbiXml>
Description: This returns a list of locations and their details.
Syntax:
<LocationListRq />
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <LocationListRq /> </FbiMsgsRq> </FbiXml>
Description: This returns information on a Location.
Syntax:
<LocationQueryRq> <LocationID>DB int</LocationID> <TagNum>int</TagNum> </LocationQueryRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <LocationQueryRq> <LocationID>10</LocationID> </LocationQueryRq> </FbiMsgsRq> </FbiXml>
Description: This logs a user into Fishbowl. The IAID and the IAName must be unique per Fishbowl Server.
Note: Use of the LoginRq is discouraged. Instead, the REST API for Fishbowl Advanced should be used with a certificate to encrypt the traffic.
Syntax:
<LoginRq> <IAID>int</IAID> <IAName>string</IAName> <IADescription>string</IADescription> <Username>string</Username> <UserPassword>string</UserPassword> </LoginRq>
Example:
<FbiXml> <Ticket> <Key /> </Ticket> <FbiMsgsRq> <LoginRq> <IAID>1234</IAID> <IAName>Fishbowl Developer Hook</IAName> <IADescription>Fishbowl Developer Hook an API test application for Fishbowl Inventory</IADescription> <UserName>admin</UserName> <UserPassword>ISMvKXpXpadDiUoOSoAfww==</UserPassword> </LoginRq> </FbiMsgsRq> </FbiXml>
Description: This makes a payment on the specified order.
Updated: 2012.3
Syntax:
<MakePaymentRq>
<Payment>Payment object</Payment>
</MakePaymentRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <MakePaymentRq> <Payment> <Amount>99.99</Amount> <SalesOrderNumber>50047</SalesOrderNumber> <PaymentDate>2019-01-12T01:12:34</PaymentDate> <PaymentMethod>VISA</PaymentMethod> <Confirmation>987</Confirmation> <TransactionID>456</TransactionID> <AuthorizationCode>321</AuthorizationCode> <MerchantAccount>1234567</MerchantAccount> <CreditCard> <CardNumber>4111111111111111</CardNumber> <CardExpMonth>02</CardExpMonth> <CardExpYear>2019</CardExpYear> <SecurityCode>523</SecurityCode> <NameOnCard>John Doe</NameOnCard> <CardAddress>123 S Riverdale Road</CardAddress> <CardZipCode>84172</CardZipCode> <CardCountryCode>US</CardCountryCode> </CreditCard> </Payment> </MakePaymentRq> </FbiMsgsRq> </FbiXml>
Description: This moves items from one specified location to another.
Syntax:
<MoveRq> <SourceLocation> <Location>Location object</Location> </SourceLocation> <Part>Part object</Part> <Quantity>int</Quantity> <Note>string</Note> <Tracking>Tracking object</Tracking> <DestinationLocation> <Location>Location object</Location> </DestinationLocation> </MoveRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <MoveRq> <SourceLocation> <Location> <LocationID>1</LocationID> <TypeID>10</TypeID> <Name>Stock 100</Name> <LocationGroupID>1</LocationGroupID> <TagID>1</TagID> <TagNumber>1</TagNumber> </Location> </SourceLocation> <Part> <PartID>68</PartID> <PartClassID>0</PartClassID> <TypeID>10</TypeID> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <Num>B200</Num> <Description>Discount Brake Cables</Description> <Details /> <StandardCost>0</StandardCost> <HasBOM>false</HasBOM> <Configurable>false</Configurable> <ActiveFlag>true</ActiveFlag> <SerializedFlag>false</SerializedFlag> <TrackingFlag>false</TrackingFlag> <Weight>0.01</Weight> <WeightUOM> <UOM> <UOMID>3</UOMID> <Name>Pound</Name> <Code>lbs</Code> <Integral>false</Integral> <Active>true</Active> <Type>Weight</Type> <UOMConversions> <UOMConversion> <MainUOMID>3</MainUOMID> <ToUOMID>8</ToUOMID> <ToUOMCode>kg</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.2046000957489014</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </WeightUOM> <Width>0</Width> <Height>0</Height> <Len>0</Len> <SizeUOM> <UOM> <UOMID>2</UOMID> <Name>Foot</Name> <Code>ft</Code> <Integral>false</Integral> <Active>true</Active> <Type>Length</Type> <UOMConversions> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>7</ToUOMID> <ToUOMCode>in</ToUOMCode> <ConversionMultiply>12.0</ConversionMultiply> <ConversionFactor>1.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>9</ToUOMID> <ToUOMCode>m</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>3.2808001041412354</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </SizeUOM> <UPC /> <VendorPartNums> <VendorPartNumber> <Number>B200</Number> </VendorPartNumber> <VendorPartNumber> <Number>B200</Number> </VendorPartNumber> <VendorPartNumber> <Number>B200</Number> </VendorPartNumber> </VendorPartNums> </Part> <Quantity>1</Quantity> <DestinationLocation> <Location> <LocationID>2</LocationID> <TypeID>20</TypeID> <Name>Shipping</Name> <LocationGroupID>1</LocationGroupID> <TagID>1</TagID> <TagNumber>1</TagNumber> </Location> </DestinationLocation> </MoveRq> </FbiMsgsRq> </FbiXml>
Description: Use this request to obtain the average cost at which you've previously bought this Part.
Syntax:
<PartCostRq>
<PartNum>string</PartNum>
</PartCostRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <PartCostRq> <PartNum>B203</PartNum> </PartCostRq> </FbiMsgsRq> </FbiXml>
Description: This returns all the information pertaining to a specified Part at your default location.
Syntax:
<PartGetRq> <Number>string</Number> <GetImage>boolean</GetImage> </PartGetRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <PartGetRq> <Number>P702</Number> <GetImage>true</GetImage> </PartGetRq> </FbiMsgsRq> </FbiXml>
Description: Like Part Get, Part Query Returns all the information pertaining to a specified Part. However, you can also specify location.
Syntax:
<PartQueryRq> <PartNum>int</PartNum> <LocationGroup>string</LocationGroup> </PartQueryRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <PartQueryRq> <PartNum>C501</PartNum> </PartQueryRq> </FbiMsgsRq> </FbiXml>
Description: This request will return all the picks that you specify. You can refine your results by its place in the index (StartIndex in conjunction with RecordCount), pick number, order number, pick type, status, priority, the first date to include, last date to include, whether or not it's fulfillable, or by its location group. The starting index defines at what point the records you want returned will start, default is 0. Record count is how many records you want returned.
Syntax:
<PickQueryRq> <StartIndex>int</StartIndex> <RecordCount>int</RecordCount> <PickNum>string</PickNum> <OrderNum>string</OrderNum> <PickType>DB string</PickType> <Status>DB string</Status> <Priority>DB string</Priority> <StartDate>date/time</StartDate> <EndDate>date/time</EndDate> <Fulfillable>boolean</Fulfillable> <LocationGroup>DB string</LocationGroup> </PickQueryRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <PickQueryRq> <StartIndex>0</StartIndex> <RecordCount>10</RecordCount> <Fulfillable>true</Fulfillable> <LocationGroup>SLC</LocationGroup> </PickQueryRq> </FbiMsgsRq> </FbiXml>
Description: This prints the default report for the specified module.
Syntax:
<PrintReportRq> <ModuleName>Shipping</ModuleName> <ParameterList> <ReportParam> <Name>shipID</Name> <Value>33</Value> </ReportParam> </ParameterList> </PrintReportRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <PrintReportRq> <ModuleName>Shipping</ModuleName> <ParameterList> <ReportParam> <Name>shipID</Name> <Value>33</Value> </ReportParam> </ParameterList> </PrintReportRq> </FbiMsgsRq> </FbiXml>
Description: This requests detailed information about the product. This includes the product's underlying part, the product's base UOM, and its tracking information. GetImage is a flag indicating if the image should be included.
Syntax:
<ProductGetRq> <Number>string</Number> <GetImage>boolean</GetImage> </ProductGetRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <ProductGetRq> <Number>B200</Number> </ProductGetRq> </FbiMsgsRq> </FbiXml>
Description: This requests the best price for a given product.
Added: 2015.2
Syntax:
<ProductPriceRq> <ProductNumber>string</ProductNumber> <CustomerName>string</CustomerName> <Quantity>int</Quantity> <Date>date</Date> </ProductPriceRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <ProductPriceRq> <ProductNumber>B201</ProductNumber> <CustomerName>Andrea Akers</CustomerName> </ProductPriceRq> </FbiMsgsRq> </FbiXml>
Description: This will do an automatic pick, pack, and ship on a sales order that has already been issued (Work orders tied to the SO must be fulfilled also). Fishbowl automatically picks the best tracking available. FulfillServiceItems indicates if the service items on the SO should be fulfilled during a ship.
Updated: 16.11
Syntax:
<QuickShipRq> <SONumber>string</SONumber> <FulfillServiceItems>boolean</FulfillServiceItems> <LocationGroup>string</LocationGroup> <ErrorIfNotFulfilled>boolean</ErrorIfNotFulfilled> <ShipDate>date</ShipDate> </QuickShipRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <QuickShipRq> <SONumber>50067</SONumber> <FulfillServiceItems>true</FulfillServiceItems> <LocationGroup>SLC</LocationGroup> </QuickShipRq> </FbiMsgsRq> </FbiXml>
Description: This returns information about orders in the Receiving module. You can narrow your search by filling in as many of the controls as you wish. It will return all orders that contain the specified details. Note: To get a response, the order number specified must be a receiving order!
Syntax:
<ReceivingListRq> <OrderNumber>string</OrderNumber> <OrderType>DB int</OrderType> <ReceiptStatus>DB int</ReceiptStatus> <StartRecord>int</StartRecord> <RecordCount>int</RecordCount> <DateIssuedBegin>date/time</DateIssuedBegin> <DateIssuedEnd>date/time</DateIssuedEnd> <DateFulfilledBegin>date/time</DateFulfilledBegin> <DateFulfilledEnd>date/time</DateFulfilledEnd> <DateReceivedBegin>date/time</DateReceivedBegin> <DateReceivedEnd>date/time</DateReceivedEnd> <DateReconciledBegin>date/time</DateReconciledBegin> <DateReconciledEnd>date/time</DateReconciledEnd> <PartNum>string</PartNum> <PartDesc>string</PartDesc> <LocationGroupID>DB int</LocationGroupID> <RMANum>string</RMANum> <VendorName>string</VendorName> </ReceivingListRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <ReceivingListRq> <OrderNumber>50</OrderNumber> <OrderType>20</OrderType> <ReceiptStatus>10</ReceiptStatus> <StartRecord>1</StartRecord> <RecordCount>10</RecordCount> </ReceivingListRq> </FbiMsgsRq> </FbiXml>
Description: This saves and updates discounts.
Syntax:
<SaveDiscountRq>
<Discount>Discount object</Discount>
</SaveDiscountRq>
Example:
<SaveDiscountRq> <Discount> <ID>9</ID> <Type>Amount</Type> <TypeID>10</TypeID> <Name>Happy</Name> <Description /> <Percentage>.1</Percentage> <Amount>10</Amount> <TaxableFlag>true</TaxableFlag> </Discount> </SaveDiscountRq>
Description: This saves an image to the associated object.
Added: 2016.3
Syntax:
<SaveImageRq> <Type>string</Type> <Number>string</Number> <Image>string</Image> <UpdateAssociations>boolean</UpdateAssociations> </SaveImageRq>
Example:
<SaveImageRq> <Type>Part</Type> <Number>B201</Number> <Image>/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a HBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIy MjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCADwAUADASIA AhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQA AAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3 ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWm p6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEA AwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSEx BhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElK U1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3 uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwCHw/o+ hXPhzTZZNI06WRrSIyO1shYtsGSTjk5rT/sDw91/sLTf/AVP8K5Cylt9K8L6bbxPM819FG+yN9uC +t2T3E6PFB5qbpdzKcdj9MUmzphhnNXTOuHh/w/8A9ALTf/ARP8KVfD3h8/8AMC0z</Image> </SaveImageRq>
Description: This request enables you to make changes to, and fulfill, picks.
Syntax:
<SavePickRq>
<Pick>Pick object</Pick>
</SavePickRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <SavePickRq> <Pick> <PickID>1</PickID> <Number>S50007</Number> <Type>Pick</Type> <TypeID>10</TypeID> <Status>Finished</Status> <StatusID>40</StatusID> <Priority>3-Normal</Priority> <PriorityID>30</PriorityID> <LocationGroupID>1</LocationGroupID> <DateLastModified>2019-02-03T09:41:31</DateLastModified> <DateScheduled>2019-11-11T00:00:00</DateScheduled> <DateCreated>2019-02-07T16:13:31</DateCreated> <DateStarted>2019-02-03T09:37:13</DateStarted> <DateFinished>2019-02-03T09:37:13</DateFinished> <UserName>admin</UserName> <PickOrders> <PickOrder> <OrderType>SO</OrderType> <OrderTypeID>20</OrderTypeID> <OrderNum>50007</OrderNum> <OrderID>7</OrderID> <OrderTo>Mountaineer Bikes</OrderTo> <Note /> </PickOrder> </PickOrders> <PickItems> <PickItem> <PickItemID>179</PickItemID> <Status>40</Status> <Part> <PartID>39</PartID> <PartClassID>0</PartClassID> <TypeID>10</TypeID> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <Num>PB3002</Num> <Description>Protein Boost Power Bar</Description> <Details /> <StandardCost>0</StandardCost> <HasBOM>false</HasBOM> <Configurable>false</Configurable> <ActiveFlag>true</ActiveFlag> <SerializedFlag>false</SerializedFlag> <TrackingFlag>true</TrackingFlag> <Weight>2</Weight> <WeightUOM> <UOM> <UOMID>3</UOMID> <Name>Pound</Name> <Code>lbs</Code> <Integral>false</Integral> <Active>true</Active> <Type>Weight</Type> <UOMConversions> <UOMConversion> <MainUOMID>3</MainUOMID> <ToUOMID>8</ToUOMID> <ToUOMCode>kg</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.2046000957489014</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </WeightUOM> <Width>0</Width> <Height>0</Height> <Len>0</Len> <SizeUOM> <UOM> <UOMID>2</UOMID> <Name>Foot</Name> <Code>ft</Code> <Integral>false</Integral> <Active>true</Active> <Type>Length</Type> <UOMConversions> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>7</ToUOMID> <ToUOMCode>in</ToUOMCode> <ConversionMultiply>12.0</ConversionMultiply> <ConversionFactor>1.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>9</ToUOMID> <ToUOMCode>m</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>3.2808001041412354</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </SizeUOM> <UPC /> <PartTrackingList> <PartTracking> <PartTrackingID>3</PartTrackingID> <Name>Expiration Date</Name> <Abbr>ExpDate</Abbr> <Description /> <SortOrder>3</SortOrder> <TrackingTypeID>30</TrackingTypeID> <Active>true</Active> </PartTracking> </PartTrackingList> <VendorPartNums> <VendorPartNumber> <Number>EZ-300-PB</Number> </VendorPartNumber> <VendorPartNumber> <Number>PB3002</Number> </VendorPartNumber> </VendorPartNums> </Part> <Tag> <TagID>0</TagID> <Num>0</Num> <PartNum /> <Location> <LocationID>0</LocationID> <TypeID>0</TypeID> <Name /> <Description /> <CountedAsAvailable>true</CountedAsAvailable> <Active>true</Active> <Pickable>true</Pickable> <Receivable>true</Receivable> <LocationGroupID>0</LocationGroupID> <LocationGroupName /> <TagID>-1</TagID> <TagNumber>-1</TagNumber> </Location> <Quantity>0</Quantity> <QuantityCommitted>0</QuantityCommitted> <WONum>N/A</WONum> <DateCreated>2019-08-17T15:43:51</DateCreated> <Tracking /> <TypeID>30</TypeID> <AccountID>1</AccountID> </Tag> <Quantity>4</Quantity> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <Tracking> <TrackingItem> <PartTracking> <PartTrackingID>3</PartTrackingID> <Name>Expiration Date</Name> <Abbr>ExpDate</Abbr> <Description /> <SortOrder>3</SortOrder> <TrackingTypeID>30</TrackingTypeID> <Active>true</Active> </PartTracking> <TrackingValue>2019-12-08T00:00:00</TrackingValue> </TrackingItem> </Tracking> <DestinationTag> <Tag> <TagID>376</TagID> <Num>363</Num> <PartNum /> <Location> <LocationID>2</LocationID> <TypeID>20</TypeID> <Name>Shipping</Name> <Description>The place where items are packaged and shipped.</Description> <CountedAsAvailable>true</CountedAsAvailable> <Default>true</Default> <Active>true</Active> <Pickable>true</Pickable> <Receivable>true</Receivable> <LocationGroupID>1</LocationGroupID> <LocationGroupName>SLC</LocationGroupName> <SortOrder>10006</SortOrder> <TagID>376</TagID> <TagNumber>363</TagNumber> </Location> <Quantity>0</Quantity> <QuantityCommitted>0</QuantityCommitted> <WONum>N/A</WONum> <DateCreated>2019-08-31T08:16:10</DateCreated> <Tracking /> <TypeID>10</TypeID> <AccountID>1</AccountID> </Tag> </DestinationTag> <OrderType>SO</OrderType> <OrderTypeID>20</OrderTypeID> <OrderNum>50007</OrderNum> <OrderID>7</OrderID> <SoItemId>12</SoItemId> <SlotNumber>1</SlotNumber> <Note /> <Location> <LocationID>7</LocationID> <TypeID>10</TypeID> <Name>Stock 200</Name> <Description>A location within the Stockroom</Description> <CountedAsAvailable>true</CountedAsAvailable> <Active>true</Active> <Pickable>true</Pickable> <Receivable>true</Receivable> <LocationGroupID>1</LocationGroupID> <LocationGroupName>SLC</LocationGroupName> <SortOrder>10011</SortOrder> <TagID>381</TagID> <TagNumber>368</TagNumber> </Location> <PickItemType>10</PickItemType> </PickItem> </PickItems> </Pick> </SavePickRq> </FbiMsgsRq> </FbiXml>
Description: This updates receipt stored data.
Syntax:
<SaveReceiptRq>
<Receipt>Receipt object</Receipt>
</SaveReceiptRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <SaveReceiptRq> <Receipt> <ID>92</ID> <StatusID>10</StatusID> <TypeID>20</TypeID> <OrderTypeID>20</OrderTypeID> <POID>66</POID> <UserID>1</UserID> <LocationGroupID>1</LocationGroupID> <ReceiptItems> <ReceiveItem> <ID>350</ID> <ItemNum>BTY100-Core</ItemNum> <Description>Battery Pack</Description> <LineNum>2</LineNum> <ItemStatus>10</ItemStatus> <ItemType>1</ItemType> <DateLastModified>2019-08-09T11:05:45</DateLastModified> <OrderNum>500100</OrderNum> <OrderType>20</OrderType> <PoItemId>162</PoItemId> <OrderItemType>20</OrderItemType> <ReceiptID>92</ReceiptID> <Quantity>1</Quantity> <UOMName>Each</UOMName> <UOMID>1</UOMID> <SuggestedLocationID>3</SuggestedLocationID> <OriginalUnitCost>-95</OriginalUnitCost> <BilledUnitCost>-95</BilledUnitCost> <LandedUnitCost>-95</LandedUnitCost> <DeliverTo /> <CarrierID>1</CarrierID> <PartTypeID>10</PartTypeID> <TrackingNum /> <PackageCount>1</PackageCount> <DateScheduled>2019-08-29T00:00:00</DateScheduled> <ReceivedReceipts> <ReceivedReceipt> <ItemType>1</ItemType> <Quantity>1</Quantity> <Reason /> <LocationID>3</LocationID> <Tracking /> </ReceivedReceipt> </ReceivedReceipts> <LinkedOrders /> <Part> <PartID>74</PartID> <PartClassID>0</PartClassID> <TypeID>10</TypeID> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <Num>BTY100</Num> <Description>Battery Pack</Description> <Details /> <StandardCost>0</StandardCost> <HasBOM>false</HasBOM> <Configurable>false</Configurable> <ActiveFlag>true</ActiveFlag> <SerializedFlag>false</SerializedFlag> <TrackingFlag>false</TrackingFlag> <Weight>0</Weight> <WeightUOM> <UOM> <UOMID>3</UOMID> <Name>Pound</Name> <Code>lbs</Code> <Integral>false</Integral> <Active>true</Active> <Type>Weight</Type> <UOMConversions> <UOMConversion> <MainUOMID>3</MainUOMID> <ToUOMID>8</ToUOMID> <ToUOMCode>kg</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.2046000957489014</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </WeightUOM> <Width>0</Width> <Height>0</Height> <Len>0</Len> <SizeUOM> <UOM> <UOMID>2</UOMID> <Name>Foot</Name> <Code>ft</Code> <Integral>false</Integral> <Active>true</Active> <Type>Length</Type> <UOMConversions> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>7</ToUOMID> <ToUOMCode>in</ToUOMCode> <ConversionMultiply>12.0</ConversionMultiply> <ConversionFactor>1.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>2</MainUOMID> <ToUOMID>9</ToUOMID> <ToUOMCode>m</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>3.2808001041412354</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </SizeUOM> <UPC /> <VendorPartNums> <VendorPartNumber> <Number>BTY100</Number> </VendorPartNumber> </VendorPartNums> </Part> </ReceiveItem> </ReceiptItems> </Receipt> </SaveReceiptRq> </FbiMsgsRq> </FbiXml>
Description: This saves the report data (Must restart client to view changes).
Syntax:
<SaveReportRq> <ReportTree>DB String</ReportTree> <Report>Report object</Report> </SaveReportRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <SaveReportRq> <ReportTree>Company</ReportTree> <Report> <ID>-1</ID> <Name>Test Report</Name> <Path>../reports/Labels/LocationTag.jasper</Path> <Description>This is a test report</Description> </Report> </SaveReportRq> </FbiMsgsRq> </FbiXml>
Description: This saves the shipment data.
Syntax:
<SaveShipmentRq>
<Shipping>Shipping object</Shipping>>
</SaveShipmentRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <SaveShipmentRq> <Shipping> <ID>32</ID> <OrderNumber>50037</OrderNumber> <OrderType>SO</OrderType> <CreatedDate>2019-02-03T10:36:18</CreatedDate> <DateLastModified>2019-02-03T10:36:18</DateLastModified> <Carrier>Will Call</Carrier> <Status>10</Status> <FOB>Origin</FOB> <Note /> <CartonCount>1</CartonCount> <Address> <ID>169</ID> <Attn>Andrea Akers</Attn> <Street>999 Speedy Way</Street> <City>San Francisco</City> <Zip>94111</Zip> <Default>false</Default> <Residential>false</Residential> <Type>Main Office</Type> <State> <ID>6</ID> <Name>California</Name> <Code>CA</Code> <CountryID>2</CountryID> </State> <Country> <ID>2</ID> <Name>UNITED STATES</Name> <Code>US</Code> </Country> </Address> <Cartons> <Carton> <ID>33</ID> <ShipID>32</ShipID> <CartonNum>1</CartonNum> <TrackingNum /> <FreightWeight>18</FreightWeight> <FreightAmount>0</FreightAmount> <ShippingItems> <ShippingItem> <ShipItemID>86</ShipItemID> <ProductNumber>BB2001</ProductNumber> <ProductDescription>Mountain Bike</ProductDescription> <QtyShipped>1</QtyShipped> <UOM> <UOMID>1</UOMID> <Name>Each</Name> <Code>ea</Code> <Integral>true</Integral> <Active>true</Active> <Type>Count</Type> <UOMConversions> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>17</ToUOMID> <ToUOMCode>pr</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> <UOMConversion> <MainUOMID>1</MainUOMID> <ToUOMID>18</ToUOMID> <ToUOMCode>pk</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>20.0</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> <Cost>0</Cost> <SKU /> <UPC /> <SoItemId>110</SoItemId> <OrderLineItem>1</OrderLineItem> <CartonName>1</CartonName> <CartonID>33</CartonID> <TagNum>499</TagNum> <Weight>18</Weight> <WeightUOM> <UOM> <UOMID>3</UOMID> <Name>Pound</Name> <Code>lbs</Code> <Integral>false</Integral> <Active>true</Active> <Type>Weight</Type> <UOMConversions> <UOMConversion> <MainUOMID>3</MainUOMID> <ToUOMID>8</ToUOMID> <ToUOMCode>kg</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.2046000957489014</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </WeightUOM> <DisplayWeight>18</DisplayWeight> <DisplayWeightUOM> <UOM> <UOMID>3</UOMID> <Name>Pound</Name> <Code>lbs</Code> <Integral>false</Integral> <Active>true</Active> <Type>Weight</Type> <UOMConversions> <UOMConversion> <MainUOMID>3</MainUOMID> <ToUOMID>8</ToUOMID> <ToUOMCode>kg</ToUOMCode> <ConversionMultiply>1.0</ConversionMultiply> <ConversionFactor>2.2046000957489014</ConversionFactor> <ToUOMIsIntegral>false</ToUOMIsIntegral> </UOMConversion> </UOMConversions> </UOM> </DisplayWeightUOM> <Tracking> <TrackingItem> <PartTracking> <PartTrackingID>4</PartTrackingID> <Name>Serial Number</Name> <Abbr>SN(s)</Abbr> <Description /> <SortOrder>4</SortOrder> <TrackingTypeID>40</TrackingTypeID> <Active>true</Active> </PartTracking> <TrackingValue /> <SerialBoxList> <SerialBox> <Committed>false</Committed> <SerialNumList> <SerialNum> <SerialID>445</SerialID> <SerialNumID>-1</SerialNumID> <Number>BB2001-75922</Number> <PartTracking> <PartTrackingID>4</PartTrackingID> <Name>Serial Number</Name> <Abbr>SN(s)</Abbr> <Description /> <SortOrder>4</SortOrder> <TrackingTypeID>40</TrackingTypeID> <Active>true</Active> </PartTracking> </SerialNum> </SerialNumList> </SerialBox> </SerialBoxList> </TrackingItem> </Tracking> </ShippingItem> </ShippingItems> </Carton> </Cartons> </Shipping> </SaveShipmentRq> </FbiMsgsRq> </FbiXml>
Description: This request permits the change of a product UPC (Universal Product Code).
Syntax:
<SaveUPCRq> <PartNum>DB string</PartNum> <UPC>string</UPC> <UpdateProducts>boolean</UpdateProducts> </SaveUPCRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <SaveUPCRq> <PartNum>B201</PartNum> <UPC>a321</UPC> <UpdateProducts>true</UpdateProducts> </SaveUPCRq> </FbiMsgsRq> </FbiXml>
Description: This enables you to change the default location of a part. Use the database to find all the details for the Location object that you want to use as the default location.
Syntax:
<SetDefPartLocRq> <PartNum>DB string</PartNum> <Location>Location object</Location> </SetDefPartLocRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <SetDefPartLocRq> <PartNum>B200</PartNum> <Location> <LocationID>2</LocationID> <TypeID>20</TypeID> <Name>Shipping</Name> <Description>The place where items are packaged and shipped.</Description> <CountedAsAvailable>true</CountedAsAvailable> <Default>true</Default> <Active>true</Active> <Pickable>true</Pickable> <Receivable>true</Receivable> <LocationGroupID>1</LocationGroupID> <LocationGroupName>SLC</LocationGroupName> <SortOrder>10006</SortOrder> <TagID>376</TagID> <TagNumber>363</TagNumber> </Location> </SetDefPartLocRq> </FbiMsgsRq> </FbiXml>
Description: This saves and updates tax rates. Note: The percent that is entered must be entered in decimal format (i.e. 10 percent is entered as .1).
Syntax:
<SaveTaxRateRq>
<TaxRate>Tax Rate object</TaxRate>
</SaveTaxRateRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <SaveTaxRateRq> <TaxRate> <ID>2</ID> <Name>Tax</Name> <Description /> <Rate>.05</Rate> <TypeID>10</TypeID> <VendorID>6</VendorID> <DefaultFlag>true</DefaultFlag> <ActiveFlag>true</ActiveFlag> </TaxRate> </SaveTaxRateRq> </FbiMsgsRq> </FbiXml>
Description: This ships an order. Note: Order Number must be written with an S in front.
Updated: 2016.4
Syntax:
<ShipRq> <ShipNum>string</ShipNum> <ShipDate>date/time</ShipDate> <FulfillService>boolean</FulfillService> </ShipRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <ShipRq> <ShipNum>S50080</ShipNum> <ShipDate>2011-08-25</ShipDate> <FulfillService>true</FulfillService> </ShipRq> </FbiMsgsRq> </FbiXml>
Description: This requests a list of UOMs.
Syntax:
<UOMRq />
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <UOMRq /> </FbiMsgsRq> </FbiXml>
Description: This retrieves a vendor object. Note: When the currency rate is 0, then the vendor is using the default currency rate.
Syntax:
<VendorGetRq>
<Name>DB string</Name>
</VendorGetRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <VendorGetRq> <Name>Chuck's Chain Shop</Name> </VendorGetRq> </FbiMsgsRq> </FbiXml>
Description: This requests a list of all vendors.
Syntax:
<VendorListRq />
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <VendorListRq /> </FbiMsgsRq> </FbiXml>
Description: This requests a list of all vendor names.
Syntax:
<VendorNameListRq />
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <VendorNameListRq /> </FbiMsgsRq> </FbiXml>
Description: This request is used to void shipments that are in a packed status or shipped status.
Syntax:
<VoidShipmentRq>ShipNum<VoidShipmentRq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <VoidShipmentRq> <ShipNum>S10017</ShipNum> </VoidShipmentRq> </FbiMsgsRq> </FbiXml>
Description: This request is used to void sales orders.
Added: 2016.8
Syntax:
<VoidSORq>SO Number</VoidSORq>
Example:
<FbiXml> <Ticket> <Key>5ef615e9-5ae0-4ab6-9c44-323254cedf5e</Key> </Ticket> <FbiMsgsRq> <VoidSORq> <SONumber>50069</SONumber> </VoidSORq> </FbiMsgsRq> </FbiXml>